docs: fix incorrect test watch mode instruction #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdesrosiers
requested changes
Jan 11, 2026
Collaborator
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
Thanks for noticing this. I think this changed with vitest 4 and I didn't notice.
However, this is the wrong fix. You need to update the "test" script in package.json. It should be vitest run.
Contributor
Author
|
I’ve updated the |
jdesrosiers
requested changes
Jan 11, 2026
Collaborator
jdesrosiers
left a comment
jdesrosiers
left a comment
There was a problem hiding this comment.
You forgot to revert the changes to the README that aren't needed anymore.
Contributor
Author
|
Sorry for that, I updated the test script but forgot to revert the changes in README. |
jdesrosiers
approved these changes
Jan 12, 2026
jdesrosiers
pushed a commit
that referenced
this pull request
Jan 19, 2026
* fix: incorrect test watch mode instruction is fixed * test script is updated with vitest run * README.md file is reverted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README currently suggests running
npm test -- --watch, but the test scripthard-disables watch mode (
vitest --watch=false), which causes Vitest to errordue to conflicting
--watchflags.This PR updates the documentation to recommend using
npx vitest --watchinstead, which works correctly without changing existing scripts or CI behavior.
with
npm test -- --watchwith
npx vitest --watch