Tests and documentation checks

Maintainers only

These instructions require access to the private source repository. Package users can go directly to the installed examples; none of these checks are needed to use the public compiled package.

Library

pnpm typecheck
pnpm lint
pnpm test:coverage
pnpm build
pnpm test:package-types

For npm use npm run <script>, for Bun bun run <script>, and for Yarn yarn <script>. The repository's canonical lockfile is pnpm-lock.yaml.

The suite includes package-level serial-core 0.3.0 integration tests. Coverage thresholds are 90% statements, 70% branches, 92% functions, and 90% lines. Tests cover frames, CRC, routing, lifecycle, paginated logs, channel assignment, dispense outcomes, and type exports.

Documentation

pnpm docs:generate
pnpm docs:check
pnpm docs:build
pnpm docs:preview

The reference generator extracts every event and application method from source, in both languages. Generated Markdown is committed for GitHub browsing. docs:check verifies it is synchronized and compiles TypeScript examples. VitePress rejects broken internal page links during the production build.

Physical verification

Automated doubles do not model USB failures, native driver permissions, electrical noise, firmware timing, or currency scaling. Validate the actual device/adapter combination before shipping a hardware integration.