microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-15 13:39:24 -06:00
Code Issues Packages Projects Releases 177 Wiki Activity
vscode/extensions/html-language-features/CONTRIBUTING.md
Robo b5a6aa14a8
feat: switch to npm as default package manager (#226927) 
* feat: move from yarn to npm

* chore: skip yarn.lock files

* fix: playwright download

* chore: fix compile and hygiene

* chore: bump vsce@2.17.0

Refs 8b49e9dfdf

* test: update results for bat and sh colorizer tests

* fix: add missing lock files for windows

* fix: switch to legacy-peer-deps

* chore: update markdown-it@14.1.0

Refs 737c95a129

esbuild step in extensions-ci-pr was previously using markdown-it
from root which had userland punycode and was able to compile successfully.

* ci: increase pr timeout for windows integration tests

* chore: fix product build

* build: ignore extension dev dependency for rcedit

* build: fix working directory inside container

* build: fix dependency generation

* npm: update dependencies

* ci: use global npmrc

* ci: update cache

* ci: setup global npmrc for private npm auth

* build: fix extension bundling

* chore: sync npm dependencies

* ci: debug env variables for container

* ci: fix win32 cli pipeline

* build: fix npmrc config usage for build/ and remote/ dirs

* fix: windows build

* fix: container builds

* fix: markdown-language-features tests and bundling

```
[03:58:22] Error: Command failed: /Users/demohan/.nvm/versions/node/v20.15.1/bin/node /Users/demohan/github/vscode/extensions/markdown-language-features/esbuild-notebook.js --outputRoot /Users/demohan/github/vscode/.build/extensions/markdown-language-features
✘ [ERROR] Could not resolve "punycode"

    extensions/markdown-language-features/node_modules/markdown-it/lib/index.js:14:27:
      14 │ var punycode     = require('punycode');
         ╵                            ~~~~~~~~~~

  The package "punycode" wasn't found on the file system but is built into node. Are you trying to bundle for node? You can use "platform: 'node'" to do that, which will remove this error.
```

Adds userland package based on beed9aee2c

* fix: container builds for distro

* chore: update yarn occurrences

* fixup! chore: bump vsce@2.17.0

Uses the closest version to `main` branch that does not
include d3cc84cdec
while still having the fix 8b49e9dfdf

* chore: sync npm dependencies

* chore: sync npm dependencies

* chore: sync npm dependencies

* chore: throw error when yarn is used for installation

* chore: add review feedback

* chore: switch exec => run where needed

* chore: npm sync dependencies

* fix: markdown-language-features bundling

```
✘ [ERROR] Could not resolve "punycode"

    extensions/markdown-language-features/node_modules/markdown-it/lib/index.js:14:27:
      14 │ var punycode     = require('punycode');
         ╵                            ~~~~~~~~~~

  The package "punycode" wasn't found on the file system but is built into node. Are you trying to bundle for node? You can use "platform: 'node'" to do that, which will remove this error.
```

Adds missing userland package based on markdown-it/markdown-it@beed9ae,
can be removed once we update markdown-it >= 14.1.0

* ci: rename no-yarn-lock-changes.yml

* chore: sync npm dependencies

* ci: restore no-yarn-lock-changes.yml

We can disable it in a separate PR to keep the required
checks happy and also need workflow edit perms.

* chore: sync npm dependencies

* ci: rebuild cache

* ci: fix no-package-lock-changes.yml

* chore: bump distro

* chore: rm yarn.lock files

* chore: rm yarn.lock files without dependencies

* chore: add vscode-selfhost-import-aid to postinstall dirs

* chore: bump distro
2024-09-06 22:18:02 +09:00

3.1 KiB
Raw Permalink Blame History

Setup

  • Clone microsoft/vscode
  • Run npm i at /, this will install
    • Dependencies for /extension/html-language-features/
    • Dependencies for /extension/html-language-features/server/
    • devDependencies such as gulp
  • Open /extensions/html-language-features/ as the workspace in VS Code
  • In /extensions/html-language-features/ run npm run compile(or npm run watch) to build the client and server
  • Run the Launch Extension debug target in the Debug View. This will:
    • Launch a new VS Code instance with the html-language-features extension loaded
  • Open a .html file to activate the extension. The extension will start the HTML language server process.
  • Add "html.trace.server": "verbose" to the settings to observe the communication between client and server in the HTML Language Server output.
  • Debug the extension and the language server client by setting breakpoints inhtml-language-features/client/
  • Debug the language server process by using Attach to Node Process command in the VS Code window opened on html-language-features.
    • Pick the process that contains htmlServerMain in the command line. Hover over code-insiders resp code processes to see the full process command line.
    • Set breakpoints in html-language-features/server/
  • Run Reload Window command in the launched instance to reload the extension

Contribute to vscode-html-languageservice

microsoft/vscode-html-languageservice contains the language smarts for html. This extension wraps the html language service into a Language Server for VS Code. If you want to fix html issues or make improvements, you should make changes at microsoft/vscode-html-languageservice.

However, within this extension, you can run a development version of vscode-html-languageservice to debug code or test language features interactively:

Linking vscode-html-languageservice in html-language-features/server/

  • Clone microsoft/vscode-html-languageservice
  • Run npm i in vscode-html-languageservice
  • Run npm link in vscode-html-languageservice. This will compile and link vscode-html-languageservice
  • In html-language-features/server/, run npm link vscode-html-languageservice

Testing the development version of vscode-html-languageservice

  • Open both vscode-html-languageservice and this extension in two windows or with a single window with themulti-root workspace feature
  • Run npm run watch at html-languagefeatures/server/ to recompile this extension with the linked version of vscode-html-languageservice
  • Make some changes in vscode-html-languageservice
  • Now when you run Launch Extension debug target, the launched instance will use your development version of vscode-html-languageservice. You can interactively test the language features.