Skip to content

Commit dea19fd

Browse files
ricokahlermrmckeb
authored andcommitted
Add --no-watch test flag to docs (#6331)
1 parent a78be99 commit dea19fd

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

docusaurus/docs/debugging-tests.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ Use the following [`launch.json`](https://code.visualstudio.com/docs/editor/debu
5454
"args": [
5555
"test",
5656
"--runInBand",
57-
"--no-cache"
57+
"--no-cache",
58+
"--no-watch"
5859
],
5960
"cwd": "${workspaceRoot}",
6061
"protocol": "inspector",

docusaurus/docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ npm start
1818
1919
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
2020

21-
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.
21+
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.
2222

2323
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
2424

docusaurus/docs/running-tests.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,14 @@ We recommend to put the test files (or `__tests__` folders) next to the code the
2929

3030
## Command Line Interface
3131

32-
When you run `npm test`, Jest will launch in the watch mode. Every time you save a file, it will re-run the tests, just like `npm start` recompiles the code.
32+
When you run `npm test`, Jest will launch in watch mode<sup>\*</sup>. Every time you save a file, it will re-run the tests, just like `npm start` recompiles the code.
3333

3434
The watcher includes an interactive command-line interface with the ability to run all tests, or focus on a search pattern. It is designed this way so that you can keep it open and enjoy fast re-runs. You can learn the commands from the “Watch Usage” note that the watcher prints after every run:
3535

3636
![Jest watch mode](https://jestjs.io/img/blog/15-watch.gif)
3737

38+
> \*Although we recommend running your tests in watch mode during development, you can disable this behavior by passing in the `--no-watch` flag. In most CI environments, this is handled for you (see [On CI servers](#on-ci-servers)).
39+
3840
## Version Control Integration
3941

4042
By default, when you run `npm test`, Jest will only run the tests related to files changed since the last commit. This is an optimization designed to make your tests run fast regardless of how many tests you have. However it assumes that you don’t often commit the code that doesn’t pass the tests.
@@ -372,9 +374,9 @@ CI=true npm test
372374
CI=true npm run build
373375
```
374376

375-
The test command will force Jest to run tests once instead of launching the watcher.
377+
The test command will force Jest to run in CI-mode, and tests will only run once instead of launching the watcher.
376378

377-
> If you find yourself doing this often in development, please [file an issue](https://github.com/facebook/create-react-app/issues/new) to tell us about your use case because we want to make watcher the best experience and are open to changing how it works to accommodate more workflows.
379+
For non-CI environments, you can simply pass the `--no-watch` flag to disable test-watching.
378380

379381
The build command will check for linter warnings and fail if any are found.
380382

0 commit comments

Comments
 (0)