Skip to content

Development

Use the local scripts before changing public API behavior or published documentation.

Local Checks

sh
pnpm lint
pnpm build
pnpm test
pnpm docs:build

pnpm check runs TypeScript without emitting files:

sh
pnpm check

Documentation

Run VitePress locally:

sh
pnpm docs:dev

Build the static documentation:

sh
pnpm docs:build

Keep README, docs pages, and public API examples aligned when behavior, install instructions, or public exports change.

Changesets

Package-visible changes need a Changeset with the smallest correct SemVer bump:

sh
pnpm changeset

Use minor for additive public exports and patch for fixes or documentation improvements.

Released under the MIT License.