cerxes/babel
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

chore(doc): add jest specific pckg command (#13607)

Browse Source 
* chore(doc): add jest specific pckg command

* chore(doc): add debug and grep

* fix(doc): nitpicks

* chore(doc): 🎨 reshape a bit

* fix(doc): 🔍 fix nitpicks 2

* fix(doc): useless tabs

* chore(doc): simplify few lines

* chore(doc): nit picks
This commit is contained in:
Tony Gorez 2021-08-03 16:25:14 +02:00 committed by GitHub
parent 1960f23c22
commit 5f4b58f678
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
CONTRIBUTING.md
View File

@ -82,45 +82,59 @@ $ make build-dist
### Running linting/tests ### Running linting/tests
You can run lint via: #### Lint
```sh ```sh
# ~6 sec on a MacBook Pro (Mid 2015) # ~6 sec on a MacBook Pro (Mid 2015)
$ make lint $ make lint
``` ```
You can run eslint's autofix via: - You can run eslint's autofix via:
```sh ```sh
$ make fix $ make fix
``` ```
You can run tests + lint for all packages (slow) via: #### Tests + lint for all packages (slow) via:
```sh ```sh
# ~46 sec on a MacBook Pro (Mid 2015) # ~46 sec on a MacBook Pro (Mid 2015)
$ make test $ make test
``` ```
If you just want to run all tests: #### All tests:
```sh ```sh
# ~40 sec on a MacBook Pro (Mid 2015) # ~40 sec on a MacBook Pro (Mid 2015)
$ make test-only $ make test-only
``` ```
#### Run tests for a specific package
When working on an issue, you will most likely want to focus on a particular [packages](https://github.com/babel/babel/tree/main/packages). Using `TEST_ONLY` will only run tests for that specific package. When working on an issue, you will most likely want to focus on a particular [packages](https://github.com/babel/babel/tree/main/packages). Using `TEST_ONLY` will only run tests for that specific package.
```sh ```sh
$ TEST_ONLY=babel-cli make test $ TEST_ONLY=babel-cli make test
``` ```
`TEST_ONLY` will also match substrings of the package name: <details>
<summary>More options</summary>
<code>TEST_ONLY</code> will also match substrings of the package name:
```sh ```sh
# Run tests for the @babel/plugin-transform-classes package. # Run tests for the @babel/plugin-transform-classes package.
$ TEST_ONLY=babel-plugin-transform-classes make test $ TEST_ONLY=babel-plugin-transform-classes make test
``` ```
Or you can use Yarn:
```sh
$ yarn jest babel-cli
```
</details>
<br>
#### Run a subset of tests
Use the `TEST_GREP` variable to run a subset of tests by name: Use the `TEST_GREP` variable to run a subset of tests by name:
@ -130,16 +144,39 @@ $ TEST_GREP=transformation make test
Substitute spaces for hyphens and forward slashes when targeting specific test names: Substitute spaces for hyphens and forward slashes when targeting specific test names:
For example, for the following path:
```sh
packages/babel-plugin-transform-arrow-functions/test/fixtures/arrow-functions/destructuring-parameters
```
You can use:
```sh ```sh
$ TEST_GREP="arrow functions destructuring parameters" make test $ TEST_GREP="arrow functions destructuring parameters" make test
``` ```
To enable the Node.js debugger added in v6.3.0, set the `TEST_DEBUG` environment variable: Or you can directly use Yarn:
```sh
$ yarn jest -t "arrow functions destructuring parameters"
```
#### Run test with Node debugger
To enable the Node.js debugger, set the <code>TEST_DEBUG</code> environment variable:
```sh ```sh
$ TEST_DEBUG=true make test $ TEST_DEBUG=true make test
``` ```
<details>
<summary>More options</summary>
Or you can directly use Yarn
```sh
$ yarn node --inspect-brk node_modules/jest/bin/jest.js --runInBand
```
</details>
<br>
You can combine `TEST_DEBUG` with `TEST_GREP` or `TEST_ONLY` to debug a subset of tests. If you plan to stay long in the debugger (which you'll likely do!), you may increase the test timeout by editing [test/testSetupFile.js](https://github.com/babel/babel/blob/main/test/testSetupFile.js). You can combine `TEST_DEBUG` with `TEST_GREP` or `TEST_ONLY` to debug a subset of tests. If you plan to stay long in the debugger (which you'll likely do!), you may increase the test timeout by editing [test/testSetupFile.js](https://github.com/babel/babel/blob/main/test/testSetupFile.js).
To overwrite any test fixtures when fixing a bug or anything, add the env variable `OVERWRITE=true` To overwrite any test fixtures when fixing a bug or anything, add the env variable `OVERWRITE=true`
@ -148,6 +185,8 @@ To overwrite any test fixtures when fixing a bug or anything, add the env variab
$ OVERWRITE=true TEST_ONLY=babel-plugin-transform-classes make test-only $ OVERWRITE=true TEST_ONLY=babel-plugin-transform-classes make test-only
``` ```
#### Test coverage
To test the code coverage, use: To test the code coverage, use:
```sh ```sh