Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

70 lines (44 loc) · 2.24 KB
Raw

[WIP] Contribution Guide

Thanks for taking the time to contribute!

Note: At the moment, this guide only explains how to make changes to the code.

Getting Started

git clone https://github.com/pickoba/satysfi-workshop.git
cd satysfi-workshop
npm ci
code .

It is recommended to use npm ci instead of npm install to avoid unintentional rewriting of package-lock.json.

When you open the workspace for the first time, VS Code will prompt you to install the following extensions:

These are necessary for debugging, linting and formatting, so please install them.

Building tree-sitter parsers

Some of the features (math hover preview) of this extension depend on tree-sitter parsers. To build the parsers, run

npm run build:tree-sitter

Note: Building parsers on Windows is not supported at the moment. Use WSL instead.

Debugging

You can debug the extension from the Run view:

  1. Open the Run view (ctrl/cmd + shift + D)
  2. Select "Extension" using the dropdown
  3. Press F5 to start debugging (The program will be compiled automatically)

Testing

Update: With the update of the @vscode/test-electron package, the following restrictions seem to be gone.

Because of VS Code's limitation, you cannot run the tests on CLI if you are using VS Code stable (see here). I recommend running the tests from the debug launch configuration from within VS Code itself:

  1. Open the Run view (ctrl/cmd + shift + D)
  2. Select "Extension Tests" using the dropdown
  3. Press F5 to run the tests

The results of the tests can be checked from the DEBUG CONSOLE panel.

Linting / Formatting

This project uses ESLint for linting and Prettier for formatting. Run

npm run lint

to check and

npm run fix

to fix the problems.