-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
126 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Suggest using `expect().resolves` over `expect(await ...)` syntax (`vitest/prefer-expect-resolves`) | ||
|
||
⚠️ This rule _warns_ in the 🌐 `all` config. | ||
|
||
🔧 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 --> | ||
|
||
```ts | ||
// bad | ||
it('passes', async () => { expect(await someValue()).toBe(true); }); | ||
|
||
// good | ||
it('passes', async () => { await expect(someValue()).resolves.toBe(true); }); | ||
``` | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
import { it, describe } from 'vitest' | ||
import ruleTester from '../utils/tester' | ||
import rule, { RULE_NAME } from './prefer-expect-resolves' | ||
|
||
const messageId = 'expectResolves' | ||
|
||
describe(RULE_NAME, () => { | ||
it(RULE_NAME, () => { | ||
ruleTester.run(RULE_NAME, rule, { | ||
valid: [ | ||
'expect.hasAssertions()', | ||
`it('passes', async () => { | ||
await expect(someValue()).resolves.toBe(true); | ||
});`, | ||
`it('is true', async () => { | ||
const myPromise = Promise.resolve(true); | ||
await expect(myPromise).resolves.toBe(true); | ||
}); | ||
`, | ||
`it('errors', async () => { | ||
await expect(Promise.reject(new Error('oh noes!'))).rejects.toThrowError( | ||
'oh noes!', | ||
); | ||
});` | ||
], | ||
invalid: [ | ||
{ | ||
code: 'it(\'passes\', async () => { expect(await someValue()).toBe(true); });', | ||
output: 'it(\'passes\', async () => { await expect(someValue()).resolves.toBe(true); });', | ||
errors: [{ | ||
messageId | ||
}] | ||
}, | ||
{ | ||
code: 'it(\'is true\', async () => { const myPromise = Promise.resolve(true); expect(await myPromise).toBe(true); });', | ||
output: 'it(\'is true\', async () => { const myPromise = Promise.resolve(true); await expect(myPromise).resolves.toBe(true); });', | ||
errors: [ | ||
{ | ||
messageId, | ||
endColumn: 92, | ||
column: 77 | ||
} | ||
] | ||
} | ||
] | ||
}) | ||
}) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import { AST_NODE_TYPES } from '@typescript-eslint/utils' | ||
import { createEslintRule } from '../utils' | ||
import { parseVitestFnCall } from '../utils/parseVitestFnCall' | ||
|
||
export const RULE_NAME = 'prefer-expect-resolves' | ||
type MESSAGE_IDS = 'expectResolves' | ||
type Options = [] | ||
|
||
export default createEslintRule<Options, MESSAGE_IDS>({ | ||
name: RULE_NAME, | ||
meta: { | ||
type: 'suggestion', | ||
docs: { | ||
description: 'Suggest using `expect().resolves` over `expect(await ...)` syntax', | ||
recommended: 'warn' | ||
}, | ||
fixable: 'code', | ||
messages: { | ||
expectResolves: 'Use `expect().resolves` instead' | ||
}, | ||
schema: [] | ||
}, | ||
defaultOptions: [], | ||
create: (context) => ({ | ||
CallExpression(node) { | ||
const vitestFnCall = parseVitestFnCall(node, context) | ||
|
||
if (vitestFnCall?.type !== 'expect') return | ||
|
||
const { parent } = vitestFnCall.head.node | ||
|
||
if (parent?.type !== AST_NODE_TYPES.CallExpression) | ||
return | ||
|
||
const [awaitNode] = parent.arguments | ||
|
||
if (awaitNode.type === AST_NODE_TYPES.AwaitExpression) { | ||
context.report({ | ||
node: awaitNode, | ||
messageId: 'expectResolves', | ||
fix(fixer) { | ||
return [ | ||
fixer.insertTextBefore(parent, 'await '), | ||
fixer.removeRange([ | ||
awaitNode.range[0], | ||
awaitNode.argument.range[0] | ||
]), | ||
fixer.insertTextAfter(parent, '.resolves') | ||
] | ||
} | ||
}) | ||
} | ||
} | ||
}) | ||
}) |