(docs): improve test watch mode docs #395
Merged
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
- it was not clearly stated that CI=true was what needed to be added,
so explicitly state that
- similarly, --color was an unnecessary option to pass and may have
caused confusion, potentially making users believe that it was
necessary in order to disable watch mode
- also, --color does not seem to be a valid option of Jest, but
--colors (note the s) is used to force highlighting in non-TTY
- also, properly format package.json example as JSON, including the
"scripts" section
- and add a test:watch script for context, making more explicit the
difference between non-watch and watch mode
|
feel free to propose |
Unless I'm missing something, I think this is the only comment Jared made on it: #319 (comment) , which didn't seem strong? But yea would be a separate issue, perhaps that should be voted on by users |
|
its not really up to a vote, this is Jared's project. but do what you think is right :) |
|
heads up - we have decided to undo this move. will not run in watch mode by default. sorry for the flipflop. #408 |
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.
it was not clearly stated that CI=true was what needed to be added,
so explicitly state that
similarly, --color was an unnecessary option to pass and may have
caused confusion, potentially making users believe that it was
necessary in order to disable watch mode
--colors (note the s) is used to force highlighting in non-TTY
also, properly format package.json example as JSON, including the
"scripts" section
and add a test:watch script for context, making more explicit the
difference between non-watch and watch mode
Follow-up to #385 , related to #319, #366 . Though this documentation does make me wonder whether it makes sense to have
--watchas a default. It's much more intuitive to pass--watchthan to prefix withCI=true