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.

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

Jump to bottom

fix(prefer-to-have-style): properly handle index access of style property #266

Merged
merged 4 commits into from
May 21, 2022
Merged

fix(prefer-to-have-style): properly handle index access of style property #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2d72469
fix(prefer-to-have-style): handle indexed style access
G-Rath May 20, 2022
6e18f72
fix(prefer-to-have-style): support computed properties
G-Rath May 20, 2022
186ae50
fix(prefer-to-have-style): handle number assertions properly
G-Rath May 20, 2022
8f39db1
fix(prefer-to-have-style): handle regexp literals
G-Rath May 20, 2022
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
35 changes: 35 additions & 0 deletions src/__tests__/lib/rules/prefer-to-have-style.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ ruleTester.run("prefer-to-have-style", rule, {
`expect().toBe(true)`,
`expect(el).toHaveStyle({foo:"bar"})`,
`expect(el.style).toMatchSnapshot()`,
`expect(el.style).toEqual(1)`,
`expect(el.style).toEqual(foo)`,
`expect(el.style[1]).toEqual([])`,
`expect(el.style[1]).toEqual({})`,
`expect(element.style[0]).toBe(new RegExp('reg'));`,
`expect(el).toHaveAttribute("style")`,
`React.useLayoutEffect(() => {
if (foo) {
Expand Down Expand Up @@ -132,5 +136,36 @@ ruleTester.run("prefer-to-have-style", rule, {
errors,
output: `expect(imageElement).not.toHaveStyle(\`box-shadow: inset 0px 0px 0px 400px 40px\`)`,
},
{
code: `expect(element.style[1]).toEqual('padding');`,
errors,
output: `expect(element).toHaveStyle({padding: expect.anything()});`,
},
{
code: `expect(element.style[1]).toBe(\`padding\`);`,
errors,
output: `expect(element).toHaveStyle({[\`padding\`]: expect.anything()});`,
},
{
code: `expect(element.style[1]).not.toEqual('padding');`,
errors,
},
{
code: `expect(element.style[1]).not.toBe(\`padding\`);`,
errors,
},
{
code: `expect(element.style[1]).toBe(x);`,
errors,
output: `expect(element).toHaveStyle({[x]: expect.anything()});`,
},
{
code: `expect(element.style[0]).toBe(1);`,
errors,
},
{
code: `expect(element.style[0]).toBe(/RegExp/);`,
errors,
},
],
});
69 changes: 47 additions & 22 deletions src/rules/prefer-to-have-style.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ export const meta = {
};

export const create = (context) => {
function getReplacementObjectProperty(styleName) {
if (styleName.type === "Literal") {
return camelCase(styleName.value);
}

return `[${context.getSourceCode().getText(styleName)}]`;
}
function getReplacementStyleParam(styleName, styleValue) {
return styleName.type === "Literal"
? `{${camelCase(styleName.value)}: ${context
Expand Down Expand Up @@ -148,7 +155,7 @@ export const create = (context) => {
},

//expect(el.style["foo-bar"]).toBe("baz")
[`MemberExpression[property.name=style][parent.computed=true][parent.parent.parent.property.name=/toBe$|to(Strict)?Equal/][parent.parent.parent.parent.arguments.0.type=/(Template)?Literal/][parent.parent.callee.name=expect]`](
[`MemberExpression[property.name=style][parent.computed=true][parent.parent.parent.property.name=/toBe$|to(Strict)?Equal/][parent.parent.parent.parent.arguments.0.type=/((Template)?Literal|Identifier)/][parent.parent.callee.name=expect]`](
node
) {
const styleName = node.parent.property;
Expand All @@ -157,10 +164,14 @@ export const create = (context) => {
const startOfStyleMemberExpression = node.object.range[1];
const endOfStyleMemberExpression =
node.parent.parent.arguments[0].range[1];
context.report({
node: node.property,
message: "Use toHaveStyle instead of asserting on element style",
fix(fixer) {

let fix = null;

if (
typeof styleValue.value !== "number" &&
!(styleValue.value instanceof RegExp)
) {
fix = (fixer) => {
return [
fixer.removeRange([
startOfStyleMemberExpression,
Expand All @@ -169,10 +180,20 @@ export const create = (context) => {
fixer.replaceText(matcher, "toHaveStyle"),
fixer.replaceText(
styleValue,
getReplacementStyleParam(styleName, styleValue)
typeof styleName.value === "number"
? `{${getReplacementObjectProperty(
styleValue
)}: expect.anything()}`
: getReplacementStyleParam(styleName, styleValue)
),
];
},
};
}

context.report({
node: node.property,
message: "Use toHaveStyle instead of asserting on element style",
fix,
});
},
//expect(el.style["foo-bar"]).not.toBe("baz")
Expand All @@ -185,10 +206,10 @@ export const create = (context) => {
const endOfStyleMemberExpression =
node.parent.parent.arguments[0].range[1];

context.report({
node: node.property,
message: "Use toHaveStyle instead of asserting on element style",
fix(fixer) {
let fix = null;

if (typeof styleName.value !== "number") {
fix = (fixer) => {
return [
fixer.removeRange([
node.object.range[1],
Expand All @@ -200,7 +221,13 @@ export const create = (context) => {
getReplacementStyleParam(styleName, styleValue)
),
];
},
};
}

context.report({
node: node.property,
message: "Use toHaveStyle instead of asserting on element style",
fix,
});
},
//expect(foo.style).toHaveProperty("foo", "bar")
Expand All @@ -225,9 +252,9 @@ export const create = (context) => {
fixer.replaceText(matcher, "toHaveStyle"),
fixer.replaceTextRange(
[styleName.range[0], styleValue.range[1]],
`{${camelCase(
styleName.value
)}: ${context.getSourceCode().getText(styleValue)}}`
`{${camelCase(styleName.value)}: ${context
.getSourceCode()
.getText(styleValue)}}`
),
];
},
Expand All @@ -238,10 +265,8 @@ export const create = (context) => {
[`MemberExpression[property.name=style][parent.parent.property.name=not][parent.parent.parent.property.name=toHaveProperty][parent.callee.name=expect]`](
node
) {
const [
styleName,
styleValue,
] = node.parent.parent.parent.parent.arguments;
const [styleName, styleValue] =
node.parent.parent.parent.parent.arguments;
const matcher = node.parent.parent.parent.property;

context.report({
Expand All @@ -259,9 +284,9 @@ export const create = (context) => {
fixer.replaceText(matcher, "toHaveStyle"),
fixer.replaceTextRange(
[styleName.range[0], styleValue.range[1]],
`{${camelCase(
styleName.value
)}: ${context.getSourceCode().getText(styleValue)}}`
`{${camelCase(styleName.value)}: ${context
.getSourceCode()
.getText(styleValue)}}`
),
];
},
Expand Down