95 lines
1.9 KiB
Markdown
95 lines
1.9 KiB
Markdown
|
# Enforce `test` and `it` usage conventions (`consistent-test-it`)
|
||
|
|
|
||
|
|
🔧 This rule is automatically fixable by the
|
||
|
|
[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
|
||
|
|
|
||
|
|
<!-- end auto-generated rule header -->
|
||
|
|
|
||
|
|
Jest allows you to choose how you want to define your tests, using the `it` or
|
||
|
|
the `test` keywords, with multiple permutations for each:
|
||
|
|
|
||
|
|
- **it:** `it`, `xit`, `fit`, `it.only`, `it.skip`.
|
||
|
|
- **test:** `test`, `xtest`, `test.only`, `test.skip`.
|
||
|
|
|
||
|
|
## Rule details
|
||
|
|
|
||
|
|
This rule gives you control over the usage of these keywords in your codebase.
|
||
|
|
|
||
|
|
## Options
|
||
|
|
|
||
|
|
This rule can be configured as follows
|
||
|
|
|
||
|
|
```json5
|
||
|
|
{
|
||
|
|
type: 'object',
|
||
|
|
properties: {
|
||
|
|
fn: {
|
||
|
|
enum: ['it', 'test'],
|
||
|
|
},
|
||
|
|
withinDescribe: {
|
||
|
|
enum: ['it', 'test'],
|
||
|
|
},
|
||
|
|
},
|
||
|
|
additionalProperties: false,
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
#### fn
|
||
|
|
|
||
|
|
Decides whether to use `test` or `it`.
|
||
|
|
|
||
|
|
#### withinDescribe
|
||
|
|
|
||
|
|
Decides whether to use `test` or `it` within a `describe` scope.
|
||
|
|
|
||
|
|
```js
|
||
|
|
/*eslint jest/consistent-test-it: ["error", {"fn": "test"}]*/
|
||
|
|
|
||
|
|
test('foo'); // valid
|
||
|
|
test.only('foo'); // valid
|
||
|
|
|
||
|
|
it('foo'); // invalid
|
||
|
|
it.only('foo'); // invalid
|
||
|
|
```
|
||
|
|
|
||
|
|
```js
|
||
|
|
/*eslint jest/consistent-test-it: ["error", {"fn": "it"}]*/
|
||
|
|
|
||
|
|
it('foo'); // valid
|
||
|
|
it.only('foo'); // valid
|
||
|
|
|
||
|
|
test('foo'); // invalid
|
||
|
|
test.only('foo'); // invalid
|
||
|
|
```
|
||
|
|
|
||
|
|
```js
|
||
|
|
/*eslint jest/consistent-test-it: ["error", {"fn": "it", "withinDescribe": "test"}]*/
|
||
|
|
|
||
|
|
it('foo'); // valid
|
||
|
|
describe('foo', function () {
|
||
|
|
test('bar'); // valid
|
||
|
|
});
|
||
|
|
|
||
|
|
test('foo'); // invalid
|
||
|
|
describe('foo', function () {
|
||
|
|
it('bar'); // invalid
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
The default configuration forces all top-level tests to use `test` and all tests
|
||
|
|
nested within `describe` to use `it`.
|
||
|
|
|
||
|
|
```js
|
||
|
|
/*eslint jest/consistent-test-it: ["error"]*/
|
||
|
|
|
||
|
|
test('foo'); // valid
|
||
|
|
describe('foo', function () {
|
||
|
|
it('bar'); // valid
|
||
|
|
});
|
||
|
|
|
||
|
|
it('foo'); // invalid
|
||
|
|
describe('foo', function () {
|
||
|
|
test('bar'); // invalid
|
||
|
|
});
|
||
|
|
```
|