Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

67 lines (42 loc) · 3.31 KB
Raw

Contributing to VSCode Javascript Booster

Before you start, it's useful to understand that the extension consists of two major components: the extension itself and the so-called language server. All UI interactions with VS Code are conducted inside the extension part, while all the code-analyzing logic is hidden inside the language server - a separate process to handle resource-heavy operations.

Following this architecture, below are the main scenarious that you might come across while working on this project.

  • Debugging the extension (which is: launching VS Code and this extension in debug mode)
  • Debugging the language server
  • Running integration tests (to check that all the pieces work together)
  • Running unit tests of the language server (to build new features: code actions etc.)
  • Building a Release Candidate bundle (for purpose of long-term local testing)

Debugging the extension

  • Start the configuration Client: Launch. The configuration will first build both client and server and then run the extension in debug mode.

Debugging the language server

  • Start extension in debug mode using the previous step.
  • Start the additional configuration Attach to Server in parallel to Client: Launch.

Running integration tests

  • Start the configuration Client: Integration Tests. The configuration will first build both client and server and then run the integration tests (uses debug build).

Running unit tests of the language server

Running the unit tests in watch mode:

  • Go to the server directory and run yarn test --watch.

Debugging the unit tests:

  • Start the configuration Server: Tests.

Building a Release Candidate bundle

vsce (Visual Studio Code Extensions) CLI has to be installed in order to build the extension locally (yarn global add vsce).

In order to build the extension package:

  • Bump the version in client/package.json (don't forget to revert the change later)
  • In the root repository dir, run yarn run package

The extension bundle (*.vsix) will be created in the client directory.

After that, you can load the bundle by going to the extensions tab in VS Code and choosing 'Install from VSIX...'. If the extension has already been installed from the Marketplace, it will be overwritten.

Pre-flight checklist

All releases are made using release branches, e.g. release/0.11.0.

  • Update README.md in the root directory:
    • Add new changelog entry
    • Add new code actions into the list
    • Check if other changes are needed
  • Place all the resources (gifs, etc) into the resources dir.
  • Run yarn run utils:generate:docs to update extension's readme and changelog files.
  • Initiate new release by running the command (in the root dir): yarn version [patch|minor|major]
  • Merge the release branch into master, delete it and push

Useful links