Skip to content

docs(readme): use npm run test:watch instead of npm test -- --watch#166

Merged
CryptoJones merged 1 commit into
masterfrom
docs/readme-use-npm-run-test-watch
May 19, 2026
Merged

docs(readme): use npm run test:watch instead of npm test -- --watch#166
CryptoJones merged 1 commit into
masterfrom
docs/readme-use-npm-run-test-watch

Conversation

@CryptoJones
Copy link
Copy Markdown
Owner

Closes #165.

Summary

package.json exposes a test:watch script that runs vitest in watch mode. README's Testing section pointed at npm test -- --watch, which works but is the awkward route past a purpose-built alias. CONTRIBUTING.md and tests/README.md both already correctly point at npm run test:watch. Align README so a new contributor's first read is the same shape as the rest.

Test plan

  • npm run lint — clean
  • npm test — 614 passed, 15 skipped (doc-only; no behavior change)

Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/

`package.json` exposes a dedicated `test:watch` script that already
runs vitest in watch mode (vitest's default when invoked without
the explicit `run` subcommand). README's Testing section pointed
readers at `npm test -- --watch` — which works (npm forwards the
`-- --watch` to the underlying `vitest run` command, where vitest
recognises the flag), but it's the awkward route past a purpose-
built alias.

CONTRIBUTING.md and tests/README.md both correctly point at
`npm run test:watch`; aligning README closes the drift so a new
contributor's first read isn't a slightly-worse path.

No code change; suite unchanged at 614 passed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CryptoJones CryptoJones merged commit 54517eb into master May 19, 2026
3 checks passed
@CryptoJones CryptoJones deleted the docs/readme-use-npm-run-test-watch branch May 19, 2026 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): Testing section recommends npm test -- --watch instead of the existing test:watch script

1 participant