Skip to content

Commit a31721a

Browse files
committed
Update test readme for Jest
This documentation still referenced Mocha, but tests were converted to Jest.
1 parent eda273d commit a31721a

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

test/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,25 @@ Every pull request that you submit to webpack (besides README and spelling corre
44
But don't give up hope!!! Although our tests may appear complex and overwhelming, once you become familiar with the test suite and structure, adding and creating tests will be fun and beneficial as you work inside the codebase! ❤
55

66
## tl;dr
7-
* Clone repo
8-
* Run tests (this automatically runs the setup)
9-
* `yarn test`
7+
Run all tests (this automatically runs the setup):
8+
```sh
9+
yarn test
10+
```
1011

11-
* To run an individual suite: (recommended during development for easier isolated diffs)
12+
Run an individual suite:
13+
```sh
14+
yarn jest ConfigTestCases
15+
```
1216

13-
Example: `$(npm bin)/mocha --grep ConfigTestCases`
17+
Watch mode:
18+
```sh
19+
yarn jest --watch ConfigTestCases
20+
```
21+
22+
See also: [Jest CLI docs](https://facebook.github.io/jest/docs/cli.html)
1423

1524
## Test suite overview
16-
We use MochaJS for our tests. For more information on Mocha you can visit their [homepage](https://mochajs.org/)!
25+
We use Jest for our tests. For more information on Jest you can visit their [homepage](https://facebook.github.io/jest/)!
1726

1827
### Class Tests
1928
All test files can be found in *.test.js. There are many tests that simply test API's of a specific class/file (such as `Compiler`, `Errors`, Integration, `Parser`, `RuleSet`, Validation).

0 commit comments

Comments
 (0)