Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (40 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

51 lines (40 loc) · 1.12 KB
Raw

Contributing

Contributions are welcome! Please use the discussions tab before opening a PR.

Running the extension locally

Install mise (if you don't have it already): https://mise.jdx.dev/getting-started.html

Install the dependencies:

mise install

Run the build and watch for changes:

mise run dev

This will open a new VS Code window with the extension running.

On code change:

  • the extension code (in the dist folder) will be updated automatically.
  • refresh the VS Code window to see the changes (Developer: Reload Window).

Debugging

  • With VSCode, use the Run Extension launch configuration
  • With IntelliJ IDEA, use the Debug extension run configuration

Tests

mise run test

Lint

mise run lint
mise run lint-fix # to fix lint issues
mise run lint-fix -a # to fix lint in non-updated files

mise run check # lint-fix + tests
mise run check-all # mise check + e2e tests

You can install the git hooks with

hk install --mise

https://hk.jdx.dev/mise_integration.html#hk-install-mise

Other commands

mise tasks # list all available tasks