Home

Welcome to the vscode-hg wiki!

Contributing

Prerequisites

• Node.js: Node.js Download page
• Mercurial: Mercurial SCM Downloads page
• Visual Studio Code: Visual Studio Code Downloads page

Setup

• Fork the repository and clone your fork
  • Hint: use GitHub Desktop for cloning
  • Optionally, download and install git and clone it from Visual Studio Code or from the command line
• In Visual Studio Code, open your repository folder
• Install npm dependencies: open the terminal and run npm install
• Compile the code: run npm run compile

Testing and debugging

From the opened repository in VS Code, press F5. Alternatively, go to the debug menu and click Start Debugging. This will open another version of VS Code in extension debug mode. Here you can test changes. It is useful to inspect the HG log, by Ctrl + Shift + P -> Hg: Show hg log.

When updating extension code you will need to restart the VS code running on debug mode. This can be done using the green restart button on the debug menu at the top of the screen or by pressing Ctrl + Shift + F5

Linting and Formatting

Make sure your code is lint-free and formatted before opening a pull request.

• Install Prettier - Code formatter extension for VS Code for automatic formatting
• Run task 'npm: lint' in VS Code to list lint warnings and errors

Useful sources

• Visual Studio Code - Your First Extension
• Visual Studio Code - Extension Guides
• Visual Studio Code - Source Control API
• Git extension for Visual Studio Code