This article is for developers who want to contribute to the CMake Tools open source project.
As with most VS Code extensions, you'll need Node.JS installed. We use yarn to compile the code (run npm install -g yarn
to install it).
The process is:
-
Open the repo in VS Code
-
Press F5 to build and run the extension
Code is formatted using the default TypeScript formatter in VS Code and uses 4 space indentation.
We use eslint for linting our sources.
You can run eslint
across the sources from a terminal or command prompt by running yarn run lint
.
Warnings from eslint
show up in the Errors and Warnings pane and you can navigate to them from inside VS Code.
To lint the source as you make changes, install the eslint extension.
Follow the Typescript Coding guidelines.
snake_case
was used historically for variables in this repo, but that style is phased out. All new variables should belowerCamelCase
. The existing variables will be migrated to the new naming soon (or you can help out with a pull request!)
Please update the CHANGELOG.md file as part of your pull request. Follow the style within that file and give yourself credit for the changes you make.