Skip to content

fix(prefer-find-by): stop prefer-find-by fixer to break code when no … #472

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
Sep 9, 2021
Merged

fix(prefer-find-by): stop prefer-find-by fixer to break code when no … #472

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7787f62
fix(prefer-find-by): stop prefer-find-by fixer to break code when no …
dyatko Sep 8, 2021
41a8264
fix(prefer-find-by): use regex to add findByMethod
dyatko Sep 8, 2021
b0c62c3
Merge branch 'main' into fix-prefer-by
Belco90 Sep 8, 2021
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
6 changes: 4 additions & 2 deletions lib/rules/prefer-find-by.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,10 +464,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
const textDestructuring = sourceCode.getText(
allVariableDeclarations
);
const hasSpaceBeforeBracket = textDestructuring.endsWith(' }');
const symbolsToRemove = hasSpaceBeforeBracket ? 2 : 1;
const text = `${textDestructuring.substring(
0,
textDestructuring.length - 2
)}, ${findByMethod} }`;
textDestructuring.length - symbolsToRemove
)}, ${findByMethod}${hasSpaceBeforeBracket ? ' ' : ''}}`;
allFixes.push(fixer.replaceText(allVariableDeclarations, text));
}

Expand Down
29 changes: 29 additions & 0 deletions tests/lib/rules/prefer-find-by.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,35 @@ ruleTester.run(RULE_NAME, rule, {
})
`,
})),
...createScenario((waitMethod: string, queryMethod: string) => ({
code: `
import {${waitMethod}} from '@testing-library/foo';
it('tests', async () => {
const {${queryMethod}} = render()
const submitButton = await ${waitMethod}(() => expect(${queryMethod}('foo', { name: 'baz' })).not.toBeNull())
})
`,
errors: [
{
messageId: 'preferFindBy',
data: {
queryVariant: getFindByQueryVariant(queryMethod),
queryMethod: queryMethod.split('By')[1],
prevQuery: queryMethod,
waitForMethodName: waitMethod,
},
},
],
output: `
import {${waitMethod}} from '@testing-library/foo';
it('tests', async () => {
const {${queryMethod}, ${buildFindByMethod(queryMethod)}} = render()
const submitButton = await ${buildFindByMethod(
queryMethod
)}('foo', { name: 'baz' })
})
`,
})),
...createScenario((waitMethod: string, queryMethod: string) => ({
code: `
import {${waitMethod}} from '@testing-library/foo';
Expand Down