Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.35 KB
Raw

Contributing

Thank you so much for being interested in contributing to our project! Before submitting your contribution, please read the following guidelines.

How to debug the VSCode extension during development

  1. Making necessary changes to the code
  2. Run the following command to collect necessary build artifacts (download the LSP jars, etc.) and generate the vsix extension file

You should only need to run this when there are changes to the setup, such as there are new versions of the LSP jars.

npm run dev:setup
  1. Run the following script to re-compile code on changes
npm run dev
  1. Hit F5 when opening extension.ts file

Note that this file must be opened in the active editor, else VSCode will not be able to find the extension to debug

If the extension errors out related to storageUri.fsPath, make sure in the debug workspace, open a folder: the above error usually happens the first time debug is on and no workspace folder is specified.

  1. You can now place breakpoints.

Any console.log will output in DEBUG CONSOLE tab in VSCode; while runtime log message will be output to corresponding channels in the debugger instance.

  1. If you make changes to the code, restart the debugger to have the changes in effect.