Skip to main content

Maintainer quickstart

This quickstart assumes Node 22+ and npm 11+.

1) Install dependencies​

npm install

2) Build the plugin once​

npm run build

3) Run core quality checks​

npm run typecheck
npm run test
npm run lint:all

4) Run docs locally​

npm run docs:api
npm run --workspace docs/docusaurus start

5) Keep generated docs/tables in sync​

npm run sync:readme-rules-table

Useful targets​

  • npm run docs:build — full docs production build
  • npm run verify:readme-rules-table — validates README rules section sync
  • npm run test:coverage — coverage run

Before opening a PR​

  • Ensure typecheck, lint, tests, and docs build are green locally.
  • Include tests for behavioral changes.
  • Update docs for user-facing changes.