This section will cover how to setup your environment for this extension, and how to manually debug and test it.
First of all, fork this repository into your github account and clone it on your local machine.
NodeJS is required for this project, but don't worry, to keep things clear and avoid colliding NodeJS versions with your other projects, we do support Mise.
The easiest way to use NodeJS for this project is to use mise. See their documentation for the installation process.
Although, this is also possible to use NodeJS without this if you wish. Install it manually, see their documentation to get more installation details. Remember that we use the version @25.2.1, but you probably can use newer versions.
To install dependencies, just run:
$ npm installTo be able to run this extension locally, you need to compile it first:
$ npm run compileThen you need to open a new debug window with our extension loaded.
So press F5.
Warning
If you're using a compact keyboard (i.e. laptop), make sure you have Fn activated. Some devices allow you to toggle Fn via Fn Lock, otherwise, use the key combination Fn + F5.
Remember, after some code change you need to compile it again and then reload your debugging window.
If you have your debugging window running, you can follow the same steps as mentioned before.
Compile it again with npm run compile, then open the debugging window via F5.
If you have a debugging window open, you still need to recompile your project, but you don't need to close your debugging window to be able to reload your extension.
On your development window, compile it with npm run compile, then open your debugging window and reload with Ctrl + R (Cmd + R on Macbook).