Skip to content

Commit b6a22e5

Browse files
committed
feat: deprecate no-expect-resolves rule
1 parent 538e561 commit b6a22e5

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ installations requiring long-term consistency.
137137
| [no-deprecated-functions](docs/rules/no-deprecated-functions.md) | Disallow use of deprecated functions | | ![fixable][] |
138138
| [no-disabled-tests](docs/rules/no-disabled-tests.md) | Disallow disabled tests | ![recommended][] | |
139139
| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | Disallow duplicate setup and teardown hooks | | |
140-
| [no-expect-resolves](docs/rules/no-expect-resolves.md) | Disallow expect.resolves | | |
141140
| [no-export](docs/rules/no-export.md) | Prevent exporting from test files | ![recommended][] | |
142141
| [no-focused-tests](docs/rules/no-focused-tests.md) | Disallow focused tests | ![recommended][] | ![fixable][] |
143142
| [no-hooks](docs/rules/no-hooks.md) | Disallow setup and teardown hooks | | |

docs/rules/no-expect-resolves.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Avoid using `expect().resolves` (`no-expect-resolves`)
22

3+
## Deprecated
4+
5+
This rule has been deprecated in favor of
6+
[`no-restricted-matchers`](no-restricted-matchers.md) with the following config:
7+
8+
```json
9+
{
10+
"rules": {
11+
"jest/no-restricted-matchers": [
12+
"error",
13+
{ "resolves": "Use `expect(await promise)` instead." }
14+
]
15+
}
16+
}
17+
```
18+
19+
---
20+
321
Jest allows you to test a promise resolve value using `await expect().resolves`.
422
For consistency and readability this rule bans `expect().resolves` in favor of
523
`expect(await promise)`.

src/rules/no-expect-resolves.ts

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ export default createRule({
1313
description: 'Disallow expect.resolves',
1414
recommended: false,
1515
},
16+
deprecated: true,
17+
replacedBy: ['no-restricted-matchers'],
1618
messages: {
1719
expectResolves: 'Use `expect(await promise)` instead.',
1820
},

0 commit comments

Comments
 (0)