How to Contribute

Developer Reference

Documentation for the code itself is kept within the code, and is extracted viaTypeDoc. See the developer reference documentationhere.

Building extension

As with most VS Code extensions you need you needNode.JS installed.

The process if fairly straightforward:

  1. Install dependencies

$ npm install

  1. Compile the code:

$ npm run compile

Of course build command (as few others) is available as Visual Studio Code task.

Coding guidelines

Formatting

Code is formatted usingclang-format. It is recommended to installClang-Format extension.

Linting

We use tslint for linting our sources.You can run tslint across the sources by callingnpmrunlint from a terminal or command prompt.You can also runnpm:lint as a Code task by pressingCMD+P (CTRL+P on Windows) and enteringtasklint.Warnings from tslint show up in the Errors and Warnings quick box and you can navigate to them from inside Code.To lint the source as you make changes you can install thetslint extension.

Style

  • Use inline field initializers whenever possible.

  • Declare properties in constructor parameters lists, when possible.

  • UselowerCamelCase for public members, methods, and function/method parameters.

  • Usesnake_case for variables.

  • Usekebab-case for files and directories. (hyphen-separated-names)

  • Prefix private members/methods with an underscore and write them_withCamelCase