vscode/extensions/json-language-features/CONTRIBUTING.md
Samuel Bronson 1661bf4fa3 json-language-features/CONTRIBUTING.md fixes
In particular, mention npm and yarn as appropriate.
Some of the mentions had apparently been inadvertantly switched???
2019-05-04 00:43:46 -04:00

2.9 KiB

Setup

  • Clone Microsoft/vscode
  • 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
  • Run the Launch Extension 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
  • Run Reload Window command in the launched instance to reload the extension

Contribute to vscode-json-languageservice

Microsoft/vscode-json-languageservice is the library that implements the language smarts for JSON. The JSON language server forwards most the of requests to the service library. If you want to fix JSON issues or make improvements, you should make changes at Microsoft/vscode-json-languageservice.

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/

  • Clone 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

Testing the development version of vscode-json-languageservice

  • Open both vscode-json-languageservice and this extension in a single workspace with multi-root workspace 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.