github-pages-deploy-action/node_modules/eslint-plugin-jest/docs/rules/prefer-expect-assertions.md

58 lines
1.2 KiB
Markdown
Raw Normal View History

2020-05-15 05:33:08 +08:00
# Suggest using `expect.assertions()` OR `expect.hasAssertions()` (`prefer-expect-assertions`)
2020-03-07 11:45:40 +08:00
Ensure every test to have either `expect.assertions(<number of assertions>)` OR
`expect.hasAssertions()` as its first expression.
## Rule details
This rule triggers a warning if,
- `expect.assertions(<number of assertions>)` OR `expect.hasAssertions()` is not
present as first statement in a test, e.g.:
```js
test('my test', () => {
expect(someThing()).toEqual('foo');
});
```
- `expect.assertions(<number of assertions>)` is the first statement in a test
where argument passed to `expect.assertions(<number of assertions>)` is not a
valid number, e.g.:
```js
test('my test', () => {
expect.assertions('1');
expect(someThing()).toEqual('foo');
});
```
### Default configuration
The following patterns are considered warnings:
```js
2020-09-13 06:19:45 +08:00
test('my test', () => {
expect.assertions('1');
expect(someThing()).toEqual('foo');
2020-03-07 11:45:40 +08:00
});
2020-09-13 06:19:45 +08:00
test('my test', () => {
expect(someThing()).toEqual('foo');
2020-03-07 11:45:40 +08:00
});
```
The following patterns would not be considered warnings:
```js
test('my test', () => {
expect.assertions(1);
expect(someThing()).toEqual('foo');
});
test('my test', () => {
expect.hasAssertions();
expect(someThing()).toEqual('foo');
});
```