From e6a3ae661d2c045ff896c6d77e2fbfafb3d10afc Mon Sep 17 00:00:00 2001 From: Martin Aeschlimann Date: Thu, 19 Aug 2021 11:50:04 +0200 Subject: [PATCH] html-language-features CONTRIBUTING.md is wrong. Fixes #129842 --- extensions/css-language-features/CONTRIBUTING.md | 14 +++++++++----- extensions/css-language-features/package.json | 4 ++-- extensions/html-language-features/CONTRIBUTING.md | 13 ++++++++----- .../json-language-features/.vscode/launch.json | 8 +++----- extensions/json-language-features/CONTRIBUTING.md | 12 +++++++----- extensions/json-language-features/package.json | 4 ++-- 6 files changed, 31 insertions(+), 24 deletions(-) diff --git a/extensions/css-language-features/CONTRIBUTING.md b/extensions/css-language-features/CONTRIBUTING.md index be9c9854b00..1c3928b847a 100644 --- a/extensions/css-language-features/CONTRIBUTING.md +++ b/extensions/css-language-features/CONTRIBUTING.md @@ -6,15 +6,20 @@ - Dependencies for `/extension/css-language-features/` - Dependencies for `/extension/css-language-features/server/` - devDependencies such as `gulp` + - Open `/extensions/css-language-features/` as the workspace in VS Code +- In `/extensions/css-language-features/` run `yarn compile`(or `yarn watch`) to build the client and server - Run the [`Launch Extension`](https://github.com/microsoft/vscode/blob/master/extensions/css-language-features/.vscode/launch.json) debug target in the Debug View. This will: - - Launch the `preLaunchTask` task to compile the extension - Launch a new VS Code instance with the `css-language-features` extension loaded - - You should see a notification saying the development version of `css-language-features` overwrites the bundled version of `css-language-features` -- Test the behavior of this extension by editing CSS/SCSS/Less files +- Open a `.css` file to activate the extension. The extension will start the CSS language server process. +- Add `"css.trace.server": "verbose"` to the settings to observe the communication between client and server in the `CSS Language Server` output. +- Debug the extension and the language server client by setting breakpoints in`css-language-features/client/` +- Debug the language server process by using `Attach to Node Process` command in the VS Code window opened on `css-language-features`. + - Pick the process that contains `cssServerMain` in the command line. Hover over `code-insiders` resp `code` processes to see the full process command line. + - Set breakpoints in `css-language-features/server/` - Run `Reload Window` command in the launched instance to reload the extension -### Contribute to vscode-css-languageservice +## Contribute to vscode-css-languageservice [microsoft/vscode-css-languageservice](https://github.com/microsoft/vscode-css-languageservice) contains the language smarts for CSS/SCSS/Less. This extension wraps the css language service into a Language Server for VS Code. @@ -36,4 +41,3 @@ However, within this extension, you can run a development version of `vscode-css - Run `yarn watch` at `css-language-features/server/` to recompile this extension with the linked version of `vscode-css-languageservice` - Make some changes in `vscode-css-languageservice` - Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-css-languageservice`. You can interactively test the language features. -- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-css-languageservice` and `css-language-features/server/` diff --git a/extensions/css-language-features/package.json b/extensions/css-language-features/package.json index 207041a6094..7c3b8e75472 100644 --- a/extensions/css-language-features/package.json +++ b/extensions/css-language-features/package.json @@ -25,8 +25,8 @@ } }, "scripts": { - "compile": "gulp compile-extension:css-language-features-client compile-extension:css-language-features-server", - "watch": "gulp watch-extension:css-language-features-client watch-extension:css-language-features-server", + "compile": "npx gulp compile-extension:css-language-features-client compile-extension:css-language-features-server", + "watch": "npx gulp watch-extension:css-language-features-client watch-extension:css-language-features-server", "test": "node ../../node_modules/mocha/bin/mocha", "install-client-next": "yarn add vscode-languageclient@next" }, diff --git a/extensions/html-language-features/CONTRIBUTING.md b/extensions/html-language-features/CONTRIBUTING.md index d4854024ee2..2d3476d3cf9 100644 --- a/extensions/html-language-features/CONTRIBUTING.md +++ b/extensions/html-language-features/CONTRIBUTING.md @@ -6,11 +6,15 @@ - 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 `yarn compile`(or `yarn watch`) to build the client and server - Run the [`Launch Extension`](https://github.com/microsoft/vscode/blob/master/extensions/html-language-features/.vscode/launch.json) debug target in the Debug View. This will: - - Launch the `preLaunchTask` task to compile the extension - Launch a new VS Code instance with the `html-language-features` extension loaded - - You should see a notification saying the development version of `html-language-features` overwrites the bundled version of `html-language-features` -- Test the behavior of this extension by editing html files +- 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 in`html-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 @@ -30,8 +34,7 @@ However, within this extension, you can run a development version of `vscode-htm #### Testing the development version of `vscode-html-languageservice` -- Open both `vscode-html-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature +- Open both `vscode-html-languageservice` and this extension in two windows or with a single window with the[multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature - Run `yarn 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. -- You can also run the `Debug Extension and Language Server` debug target, which will launch the extension and attach the debugger to the language server. After successful attach, you should be able to hit breakpoints in both `vscode-html-languageservice` and `html-language-features/server/` diff --git a/extensions/json-language-features/.vscode/launch.json b/extensions/json-language-features/.vscode/launch.json index bb5cde48bfd..a89f4f6f693 100644 --- a/extensions/json-language-features/.vscode/launch.json +++ b/extensions/json-language-features/.vscode/launch.json @@ -11,8 +11,7 @@ ], "stopOnEntry": false, "sourceMaps": true, - "outFiles": ["${workspaceFolder}/client/out"], - "preLaunchTask": "npm" + "outFiles": ["${workspaceFolder}/client/out"] }, { "name": "Launch Tests", @@ -22,8 +21,7 @@ "args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionTestsPath=${workspaceFolder}/client/out/test" ], "stopOnEntry": false, "sourceMaps": true, - "outFiles": ["${workspaceFolder}/client/out/test"], - "preLaunchTask": "npm" + "outFiles": ["${workspaceFolder}/client/out/test"] }, { "name": "Attach Language Server", @@ -43,4 +41,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/extensions/json-language-features/CONTRIBUTING.md b/extensions/json-language-features/CONTRIBUTING.md index 7203d02e6f2..f0b0aa0ec09 100644 --- a/extensions/json-language-features/CONTRIBUTING.md +++ b/extensions/json-language-features/CONTRIBUTING.md @@ -6,13 +6,15 @@ - Dependencies for `/extension/json-language-features/server/` - devDependencies such as `gulp` - Open `/extensions/json-language-features/` as the workspace in VS Code +- In `/extensions/json-language-features/` run `yarn compile`(or `yarn watch`) to build the client and server - Run the [`Launch Extension`](https://github.com/microsoft/vscode/blob/master/extensions/json-language-features/.vscode/launch.json) debug target in the Debug View. This will: - - Launch the `preLaunchTask` task to compile the extension - Launch a new VS Code instance with the `json-language-features` extension loaded - - You should see a notification saying the development version of `json-language-features` overwrites the bundled version of `json-language-features` - Open a `.json` file to activate the extension. The extension will start the JSON language server process. -- Add `"json.trace.server": "verbose"` to the settings to observe the communication between client and server. -- Debug the language server process by using `Attach to Node Process` command in the VS Code window opened on `json-language-features` +- Add `"json.trace.server": "verbose"` to the settings to observe the communication between client and server in the `JSON Language Server` output. +- Debug the extension and the language server client by setting breakpoints in`json-language-features/client/` +- Debug the language server process by using `Attach to Node Process` command in the VS Code window opened on `json-language-features`. + - Pick the process that contains `jsonServerMain` in the command line. Hover over `code-insiders` resp `code` processes to see the full process command line. + - Set breakpoints in `json-language-features/server/` - Run `Reload Window` command in the launched instance to reload the extension @@ -33,7 +35,7 @@ However, within this extension, you can run a development version of `vscode-jso #### Testing the development version of `vscode-json-languageservice` -- Open both `vscode-json-languageservice` and this extension in a single workspace with [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature +- Open both `vscode-json-languageservice` and this extension in two windows or with a single window with the[multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) feature. - Run `yarn watch` at `json-languagefeatures/server/` to recompile this extension with the linked version of `vscode-json-languageservice` - Make some changes in `vscode-json-languageservice` - Now when you run `Launch Extension` debug target, the launched instance will use your development version of `vscode-json-languageservice`. You can interactively test the language features. diff --git a/extensions/json-language-features/package.json b/extensions/json-language-features/package.json index 09fea6814a3..1428705ead7 100644 --- a/extensions/json-language-features/package.json +++ b/extensions/json-language-features/package.json @@ -24,8 +24,8 @@ } }, "scripts": { - "compile": "gulp compile-extension:json-language-features-client compile-extension:json-language-features-server", - "watch": "gulp watch-extension:json-language-features-client watch-extension:json-language-features-server", + "compile": "npx gulp compile-extension:json-language-features-client compile-extension:json-language-features-server", + "watch": "npx gulp watch-extension:json-language-features-client watch-extension:json-language-features-server", "install-client-next": "yarn add vscode-languageclient@next" }, "categories": [