Skip to content

feat(no-wait-for-multiple-assertions): add auto-fix #1099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 8, 2025
+169 −2
Merged

feat(no-wait-for-multiple-assertions): add auto-fix #1099

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e170ba
feat: create a fixer
y-hsgw Oct 7, 2025
35bd836
test: update tests
y-hsgw Oct 7, 2025
5e57438
docs: update docs
y-hsgw Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ module.exports = [
| [no-render-in-lifecycle](docs/rules/no-render-in-lifecycle.md) | Disallow the use of `render` in testing frameworks setup functions | ![badge-angular][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | |
| [no-test-id-queries](docs/rules/no-test-id-queries.md) | Ensure no `data-testid` queries are used | | | |
| [no-unnecessary-act](docs/rules/no-unnecessary-act.md) | Disallow wrapping Testing Library utils or empty callbacks in `act` | ![badge-marko][] ![badge-react][] | | |
| [no-wait-for-multiple-assertions](docs/rules/no-wait-for-multiple-assertions.md) | Disallow the use of multiple `expect` calls inside `waitFor` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | |
| [no-wait-for-multiple-assertions](docs/rules/no-wait-for-multiple-assertions.md) | Disallow the use of multiple `expect` calls inside `waitFor` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | 🔧 |
| [no-wait-for-side-effects](docs/rules/no-wait-for-side-effects.md) | Disallow the use of side effects in `waitFor` | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | 🔧 |
| [no-wait-for-snapshot](docs/rules/no-wait-for-snapshot.md) | Ensures no snapshot is generated inside of a `waitFor` call | ![badge-angular][] ![badge-dom][] ![badge-marko][] ![badge-react][] ![badge-svelte][] ![badge-vue][] | | |
| [prefer-explicit-assert](docs/rules/prefer-explicit-assert.md) | Suggest using explicit assertions rather than standalone queries | | | |
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-wait-for-multiple-assertions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the following configs: `angular`, `dom`, `marko`, `react`, `svelte`, `vue`.

🔧 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 -->

## Rule Details
Expand Down
32 changes: 32 additions & 0 deletions lib/rules/no-wait-for-multiple-assertions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
'Avoid using multiple assertions within `waitFor` callback',
},
schema: [],
fixable: 'code',
},
defaultOptions: [],
create(context, _, helpers) {
Expand Down Expand Up @@ -108,6 +109,37 @@ export default createTestingLibraryRule<Options, MessageIds>({
context.report({
node: expressionStatement,
messageId: 'noWaitForMultipleAssertion',
fix(fixer) {
const sourceCode = getSourceCode(context);

const lineStart = sourceCode.getIndexFromLoc({
line: expressionStatement.loc.start.line,
column: 0,
});
const lineEnd = sourceCode.getIndexFromLoc({
line: expressionStatement.loc.end.line + 1,
column: 0,
});
const lines = sourceCode.getText().split('\n');
const line = lines[callExpressionNode.loc.start.line - 1];
const indent = line.match(/^\s*/)?.[0] ?? '';

const expressionStatementLines = lines.slice(
expressionStatement.loc.start.line - 1,
expressionStatement.loc.end.line
);
const statementText = expressionStatementLines
.join('\n')
.trimStart();

return [
fixer.removeRange([lineStart, lineEnd]),
fixer.insertTextAfter(
callExpressionNode,
`\n${indent}${statementText}`
),
];
},
});
}
}
Expand Down
135 changes: 134 additions & 1 deletion tests/lib/rules/no-wait-for-multiple-assertions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 4, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(() => {
expect(a).toEqual('a')
})
expect(a).toEqual('a')
`,
},
{
code: `
Expand All @@ -148,6 +154,12 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 4, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(() => {
expect(screen.getByTestId('a')).toHaveTextContent('a')
})
expect(screen.getByTestId('a')).toHaveTextContent('a')
`,
},
...SUPPORTED_TESTING_FRAMEWORKS.map<RuleInvalidTestCase>(
(testingFramework) => ({
Expand All @@ -162,6 +174,13 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `// Aggressive Reporting disabled
import { waitFor } from '${testingFramework}'
await waitFor(() => {
expect(a).toEqual('a')
})
expect(a).toEqual('a')
`,
})
),
{
Expand All @@ -176,6 +195,13 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `// Aggressive Reporting disabled
import { waitFor as renamedWaitFor } from 'test-utils'
await renamedWaitFor(() => {
expect(a).toEqual('a')
})
expect(a).toEqual('a')
`,
},
{
code: `
Expand All @@ -188,6 +214,13 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(() => {
expect(a).toEqual('a')
console.log('testing-library')
})
expect(a).toEqual('a')
`,
},
{
code: `
Expand All @@ -202,6 +235,15 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 6, column: 13, messageId: 'noWaitForMultipleAssertion' },
],
output: `
test('should whatever', async () => {
await waitFor(() => {
expect(a).toEqual('a')
console.log('testing-library')
})
expect(a).toEqual('a')
})
`,
},
{
code: `
Expand All @@ -214,6 +256,13 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(async () => {
expect(a).toEqual('a')
await somethingAsync()
})
expect(a).toEqual('a')
`,
},
{
code: `
Expand All @@ -229,6 +278,32 @@ ruleTester.run(RULE_NAME, rule, {
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
{ line: 6, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: [
`
await waitFor(function() {
expect(a).toEqual('a')
expect(a).toEqual('a')
expect(a).toEqual('a')
})
expect(a).toEqual('a')
`,
`
await waitFor(function() {
expect(a).toEqual('a')
expect(a).toEqual('a')
})
expect(a).toEqual('a')
expect(a).toEqual('a')
`,
`
await waitFor(function() {
expect(a).toEqual('a')
})
expect(a).toEqual('a')
expect(a).toEqual('a')
expect(a).toEqual('a')
`,
],
},
{
code: `
Expand All @@ -243,6 +318,24 @@ ruleTester.run(RULE_NAME, rule, {
{ line: 4, column: 11, messageId: 'noWaitForMultipleAssertion' },
{ line: 6, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: [
`
await waitFor(function() {
expect(a).toEqual('a')
expect(b).toEqual('b')
expect(b).toEqual('b')
})
expect(a).toEqual('a')
`,
`
await waitFor(function() {
expect(a).toEqual('a')
expect(b).toEqual('b')
})
expect(b).toEqual('b')
expect(a).toEqual('a')
`,
],
},
{
code: `
Expand All @@ -255,6 +348,13 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(function() {
expect(a).toEqual('a')
console.log('testing-library')
})
expect(a).toEqual('a')
`,
},
{
code: `
Expand All @@ -267,18 +367,51 @@ ruleTester.run(RULE_NAME, rule, {
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(async function() {
expect(a).toEqual('a')
const el = await somethingAsync()
})
expect(a).toEqual('a')
`,
},
{
code: `
await waitFor(() => {
expect(window.fetch).toHaveBeenCalledTimes(1);
expect(localStorage.setItem).toHaveBeenCalledWith('bar', 'baz');
expect(window.fetch).toHaveBeenCalledWith('/foo');
});
})
`,
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(() => {
expect(window.fetch).toHaveBeenCalledTimes(1);
expect(localStorage.setItem).toHaveBeenCalledWith('bar', 'baz');
})
expect(window.fetch).toHaveBeenCalledWith('/foo');
`,
},
{
code: `
await waitFor(() => {
expect(window.fetch).toHaveBeenCalledTimes(1);
expect(localStorage.setItem).toHaveBeenCalledWith('bar', 'baz');
expect(window.fetch).toHaveBeenCalledWith('/foo'); // comment
})
`,
errors: [
{ line: 5, column: 11, messageId: 'noWaitForMultipleAssertion' },
],
output: `
await waitFor(() => {
expect(window.fetch).toHaveBeenCalledTimes(1);
expect(localStorage.setItem).toHaveBeenCalledWith('bar', 'baz');
})
expect(window.fetch).toHaveBeenCalledWith('/foo'); // comment
`,
},
],
});