Missing docs: how to install from source

[fph]

Are there any instructions to install the extension directly from source? I can only find instructions that say "You can install the extension from within Visual Studio Code or download it from Visual Studio Code Marketplace", and the latter method no longer works (#212); so there really is no alternative to downloading the packaged extension from the Marketplace.

This would also help potential contributors: I can't submit a pull request if I cannot run it and test the change locally.

[dklilley]

Hi @fph , thanks for reaching out about this! This developer documentation is an area we want to expand upon. I'm going to leave this issue open to track the request for documentation improvements, but will also include some quick instructions below to help unblock you for now:

Packaging the Extension From Source: You will need Node.js to build and package the extension as a VSIX file locally. Run the following commands:

1. npm install - install the Node.js package dependencies
2. npm run package - packages the code into a VSIX file which can be installed locally

Debugging Changes Locally: When making changes to the code within VS Code, you can use the included Run actions to run and debug your changes without needing to package to a VSIX. To do this:

1. npm install - install the Node.js package dependencies
2. npm run compile - build the changes
3. Navigate to the "Run and Debug" side panel in VS Code, and select "Run & Debug" from the drop-down menu.
4. Click the play/run button (or press F5). This will both launch a separate instance of VS Code running the local version of the extension AND connect the debugger to the language server's process.