Developers Guide
April 2, 2026 ยท View on GitHub
Initial Setup
Install NodeJS 22.
Development
Testing, Building and Linting
npm install
npm test
npm run lint
npm run build
Run Sonar Locally
Install the latest Sonar CLI.
Run sonar:
export SONAR_TOKEN=abc123
sonar-scanner
Upgrade Dependencies
npx npm-check-updates -u && npm install
Releasing
Currently we release this project by hand.
Steps
- Write a changelog file
- Add a link to
doc/changes/changelog.md - Update the version in
package.json - Merge Pull Request to
main - Make a new release on GitHub
- This will trigger the release workflow and publish to npmjs.com