Developer Guide

March 7, 2025 ยท View on GitHub

setup

  • clone the repo
  • install Node.js
  • run npm run setup

test

  • run tests: npm run test

To try the extension out locally:

  • run the tests to populate the local out folder
  • menu: Run > Run Without Debugging
  • in the new VSCode instance that pops up: File > Open Folder > select folder that isn't open in a VSCode instance yet

Local installation:

  • npm run package
  • run code --install-extension contest-*.vsix in terminal
  • restart VSCode

debug

Debug in VSCode:

  • set breakpoints in VSCode
  • open Debug view: VSCode menu: View > Run
  • choose Run Extension
  • click on the play icon
  • open folder > choose a different folder than the current one

update

  • npm run update

release

  • npm run publish-patch
  • npm run publish-minor
  • npm run publish-major