Skip to content
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.

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

Already on GitHub? Sign in to your account

fix: produce valid code when when fixing properties accessed with square brackets #1131

Merged
merged 6 commits into from May 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/rules/__tests__/no-alias-methods.test.ts
Expand Up @@ -231,5 +231,20 @@ ruleTester.run('no-alias-methods', rule, {
},
],
},
{
code: 'expect(a).not["toThrowError"]()',
output: "expect(a).not['toThrow']()",
errors: [
{
messageId: 'replaceAlias',
data: {
alias: 'toThrowError',
canonical: 'toThrow',
},
column: 15,
line: 1,
},
],
},
],
});
16 changes: 16 additions & 0 deletions src/rules/__tests__/prefer-strict-equal.test.ts
Expand Up @@ -26,5 +26,21 @@ ruleTester.run('prefer-strict-equal', rule, {
},
],
},
{
code: 'expect(something)["toEqual"](somethingElse);',
errors: [
{
messageId: 'useToStrictEqual',
column: 19,
line: 1,
suggestions: [
{
messageId: 'suggestReplaceWithStrictEqual',
output: "expect(something)['toStrictEqual'](somethingElse);",
},
],
},
],
},
],
});
35 changes: 35 additions & 0 deletions src/rules/__tests__/prefer-to-be.test.ts
Expand Up @@ -45,6 +45,11 @@ ruleTester.run('prefer-to-be', rule, {
output: 'expect(value).toBe(`my string`);',
errors: [{ messageId: 'useToBe', column: 15, line: 1 }],
},
{
code: 'expect(value)["toEqual"](`my string`);',
output: "expect(value)['toBe'](`my string`);",
errors: [{ messageId: 'useToBe', column: 15, line: 1 }],
},
{
code: 'expect(value).toStrictEqual(`my ${string}`);',
output: 'expect(value).toBe(`my ${string}`);',
Expand All @@ -55,6 +60,16 @@ ruleTester.run('prefer-to-be', rule, {
output: 'expect(loadMessage()).resolves.toBe("hello world");',
errors: [{ messageId: 'useToBe', column: 32, line: 1 }],
},
{
code: 'expect(loadMessage()).resolves["toStrictEqual"]("hello world");',
output: 'expect(loadMessage()).resolves[\'toBe\']("hello world");',
errors: [{ messageId: 'useToBe', column: 32, line: 1 }],
},
{
code: 'expect(loadMessage())["resolves"].toStrictEqual("hello world");',
output: 'expect(loadMessage())["resolves"].toBe("hello world");',
errors: [{ messageId: 'useToBe', column: 35, line: 1 }],
},
{
code: 'expect(loadMessage()).resolves.toStrictEqual(false);',
output: 'expect(loadMessage()).resolves.toBe(false);',
Expand Down Expand Up @@ -103,6 +118,16 @@ ruleTester.run('prefer-to-be: null', rule, {
output: 'expect("a string").not.toBeNull();',
errors: [{ messageId: 'useToBeNull', column: 24, line: 1 }],
},
{
code: 'expect("a string").not["toBe"](null);',
output: 'expect("a string").not[\'toBeNull\']();',
errors: [{ messageId: 'useToBeNull', column: 24, line: 1 }],
},
{
code: 'expect("a string")["not"]["toBe"](null);',
output: 'expect("a string")["not"][\'toBeNull\']();',
errors: [{ messageId: 'useToBeNull', column: 27, line: 1 }],
},
{
code: 'expect("a string").not.toEqual(null);',
output: 'expect("a string").not.toBeNull();',
Expand Down Expand Up @@ -156,6 +181,11 @@ ruleTester.run('prefer-to-be: undefined', rule, {
output: 'expect("a string").rejects.toBeDefined();',
errors: [{ messageId: 'useToBeDefined', column: 32, line: 1 }],
},
{
code: 'expect("a string").rejects.not["toBe"](undefined);',
output: 'expect("a string").rejects[\'toBeDefined\']();',
errors: [{ messageId: 'useToBeDefined', column: 32, line: 1 }],
},
{
code: 'expect("a string").not.toEqual(undefined);',
output: 'expect("a string").toBeDefined();',
Expand Down Expand Up @@ -208,6 +238,11 @@ ruleTester.run('prefer-to-be: NaN', rule, {
output: 'expect("a string").rejects.not.toBeNaN();',
errors: [{ messageId: 'useToBeNaN', column: 32, line: 1 }],
},
{
code: 'expect("a string")["rejects"].not.toBe(NaN);',
output: 'expect("a string")["rejects"].not.toBeNaN();',
errors: [{ messageId: 'useToBeNaN', column: 35, line: 1 }],
},
{
code: 'expect("a string").not.toEqual(NaN);',
output: 'expect("a string").not.toBeNaN();',
Expand Down
10 changes: 10 additions & 0 deletions src/rules/__tests__/prefer-todo.test.ts
Expand Up @@ -58,5 +58,15 @@ ruleTester.run('prefer-todo', rule, {
output: 'test.todo("i need to write this test");',
errors: [{ messageId: 'emptyTest' }],
},
{
code: `test["skip"]("i need to write this test", function() {});`,
output: 'test[\'todo\']("i need to write this test");',
errors: [{ messageId: 'emptyTest' }],
},
{
code: `test[\`skip\`]("i need to write this test", function() {});`,
output: 'test[\'todo\']("i need to write this test");',
errors: [{ messageId: 'emptyTest' }],
},
],
});
11 changes: 9 additions & 2 deletions src/rules/no-alias-methods.ts
@@ -1,4 +1,9 @@
import { createRule, isExpectCall, parseExpectCall } from './utils';
import {
createRule,
isExpectCall,
parseExpectCall,
replaceAccessorFixer,
} from './utils';

export default createRule({
name: __filename,
Expand Down Expand Up @@ -56,7 +61,9 @@ export default createRule({
canonical,
},
node: matcher.node.property,
fix: fixer => [fixer.replaceText(matcher.node.property, canonical)],
fix: fixer => [
replaceAccessorFixer(fixer, matcher.node.property, canonical),
],
});
}
},
Expand Down
4 changes: 3 additions & 1 deletion src/rules/prefer-strict-equal.ts
Expand Up @@ -4,6 +4,7 @@ import {
isExpectCall,
isParsedEqualityMatcherCall,
parseExpectCall,
replaceAccessorFixer,
} from './utils';

export default createRule({
Expand Down Expand Up @@ -44,7 +45,8 @@ export default createRule({
{
messageId: 'suggestReplaceWithStrictEqual',
fix: fixer => [
fixer.replaceText(
replaceAccessorFixer(
fixer,
matcher.node.property,
EqualityMatcher.toStrictEqual,
),
Expand Down
3 changes: 2 additions & 1 deletion src/rules/prefer-to-be.ts
Expand Up @@ -12,6 +12,7 @@ import {
isIdentifier,
isParsedEqualityMatcherCall,
parseExpectCall,
replaceAccessorFixer,
} from './utils';

const isNullLiteral = (node: TSESTree.Node): node is TSESTree.NullLiteral =>
Expand Down Expand Up @@ -70,7 +71,7 @@ const reportPreferToBe = (
messageId: `useToBe${whatToBe}`,
fix(fixer) {
const fixes = [
fixer.replaceText(matcher.node.property, `toBe${whatToBe}`),
replaceAccessorFixer(fixer, matcher.node.property, `toBe${whatToBe}`),
];

if (matcher.arguments?.length && whatToBe !== '') {
Expand Down
19 changes: 7 additions & 12 deletions src/rules/prefer-todo.ts
Expand Up @@ -7,6 +7,7 @@ import {
isFunction,
isStringNode,
parseJestFnCall,
replaceAccessorFixer,
} from './utils';

function isEmptyFunction(node: TSESTree.CallExpressionArgument) {
Expand All @@ -23,20 +24,14 @@ function createTodoFixer(
jestFnCall: ParsedJestFnCall,
fixer: TSESLint.RuleFixer,
) {
const fixes = [
fixer.replaceText(jestFnCall.head.node, `${jestFnCall.head.local}.todo`),
];

if (jestFnCall.members.length) {
fixes.unshift(
fixer.removeRange([
jestFnCall.head.node.range[1],
jestFnCall.members[0].range[1],
]),
);
return replaceAccessorFixer(fixer, jestFnCall.members[0], 'todo');
}

return fixes;
return fixer.replaceText(
jestFnCall.head.node,
`${jestFnCall.head.local}.todo`,
);
}

const isTargetedTestCase = (jestFnCall: ParsedJestFnCall): boolean => {
Expand Down Expand Up @@ -91,7 +86,7 @@ export default createRule({
node,
fix: fixer => [
fixer.removeRange([title.range[1], callback.range[1]]),
...createTodoFixer(jestFnCall, fixer),
createTodoFixer(jestFnCall, fixer),
],
});
}
Expand Down
17 changes: 17 additions & 0 deletions src/rules/utils/misc.ts
Expand Up @@ -137,3 +137,20 @@ export const getTestCallExpressionsFromDeclaredVariables = (
[],
);
};

/**
* Replaces an accessor node with the given `text`, surrounding it in quotes if required.
*
* This ensures that fixes produce valid code when replacing both dot-based and
* bracket-based property accessors.
*/
export const replaceAccessorFixer = (
fixer: TSESLint.RuleFixer,
node: AccessorNode,
text: string,
) => {
return fixer.replaceText(
node,
node.type === AST_NODE_TYPES.Identifier ? text : `'${text}'`,
);
};