vscode/extensions/json-language-features/CONTRIBUTING.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

42 lines
3.1 KiB
Markdown
Raw Normal View History

2019-02-14 19:59:06 +00:00
## Setup
2020-09-15 23:13:49 +00:00
- Clone [microsoft/vscode](https://github.com/microsoft/vscode)
2019-02-14 19:59:06 +00:00
- Run `yarn` at `/`, this will install
- Dependencies for `/extension/json-language-features/`
- 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
2020-09-15 23:13:49 +00:00
- 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:
2019-02-14 19:59:06 +00:00
- Launch a new VS Code instance with the `json-language-features` extension loaded
2019-02-14 20:11:01 +00:00
- 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 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/`
2019-02-14 19:59:06 +00:00
- Run `Reload Window` command in the launched instance to reload the extension
2019-02-14 20:11:01 +00:00
2019-02-14 19:59:06 +00:00
### Contribute to vscode-json-languageservice
2020-09-15 23:13:49 +00:00
[microsoft/vscode-json-languageservice](https://github.com/microsoft/vscode-json-languageservice) is the library that implements the language smarts for JSON.
2019-02-14 20:11:01 +00:00
The JSON language server forwards most the of requests to the service library.
2020-09-15 23:13:49 +00:00
If you want to fix JSON issues or make improvements, you should make changes at [microsoft/vscode-json-languageservice](https://github.com/microsoft/vscode-json-languageservice).
2019-02-14 19:59:06 +00:00
However, within this extension, you can run a development version of `vscode-json-languageservice` to debug code or test language features interactively:
#### Linking `vscode-json-languageservice` in `json-language-features/server/`
2020-09-15 23:13:49 +00:00
- Clone [microsoft/vscode-json-languageservice](https://github.com/microsoft/vscode-json-languageservice)
- Run `npm install` in `vscode-json-languageservice`
- Run `npm link` in `vscode-json-languageservice`. This will compile and link `vscode-json-languageservice`
- In `json-language-features/server/`, run `yarn link vscode-json-languageservice`
2019-02-14 19:59:06 +00:00
#### Testing the development version of `vscode-json-languageservice`
- 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.
2019-02-14 19:59:06 +00:00
- 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.