Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs): improve test watch mode docs #395

Merged
merged 1 commit into from
Dec 28, 2019

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Dec 27, 2019

  • 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

Follow-up to #385 , related to #319, #366 . Though this documentation does make me wonder whether it makes sense to have --watch as a default. It's much more intuitive to pass --watch than to prefix with CI=true

- 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
@swyxio swyxio merged commit 531010e into jaredpalmer:master Dec 28, 2019
@swyxio
Copy link
Collaborator

swyxio commented Dec 28, 2019

feel free to propose --watch in a separate issue. altho i think if u followed those issues, jared had a strong opinion that watch should be default

@agilgur5
Copy link
Collaborator Author

altho i think if u followed those issues, jared had a strong opinion that watch should be default

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

@swyxio
Copy link
Collaborator

swyxio commented Dec 28, 2019

its not really up to a vote, this is Jared's project. but do what you think is right :)

@swyxio
Copy link
Collaborator

swyxio commented Jan 9, 2020

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants