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: arrow-body-style fixer for in wrap (fixes #11849) #13228

Merged
merged 12 commits into from Jul 11, 2020
Merged

Fix: arrow-body-style fixer for in wrap (fixes #11849) #13228

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
870ce88
Fix: add parens when in operator (fixes #11849)
anikethsaha Apr 25, 2020
e550330
Chore: some more tests
anikethsaha Apr 26, 2020
d07286c
Chore: update jsdoc comments
anikethsaha May 3, 2020
3e9f904
Update: add paren only for ForStatement
anikethsaha May 5, 2020
394f3b3
Merge remote-tracking branch 'origin/fixes-11849' into fixes-11849
anikethsaha May 5, 2020
6b6aab7
Update: fixed adding extra parens
anikethsaha May 19, 2020
11e93a5
Update: minified traversing using visitor query
anikethsaha Jun 21, 2020
6d67153
Chore: isInOp to false while existing
anikethsaha Jun 23, 2020
0cebd4c
Update: fixed the logic
anikethsaha Jun 24, 2020
ada8ae5
Update: logic
anikethsaha Jun 25, 2020
4bb134f
Update: checking inside of for loop
anikethsaha Jun 27, 2020
1e177e9
Chore: updated is for in check
anikethsaha Jun 28, 2020
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
43 changes: 38 additions & 5 deletions lib/rules/arrow-body-style.js
View file
Open in desktop
Expand Up @@ -99,6 +99,24 @@ module.exports = {
return sourceCode.getTokenAfter(node);
}

/**
* Checks if a node has `in` operator or not
* @param {Node} node The argument node which needs to be checked
* @returns {boolean} `true` if there is an `in` operator else `false`.
*/
function isIn(node) {
if (
node.type === "BinaryExpression" ||
node.type === "LogicalExpression"
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
) {
if (node.operator === "in") {
return true;
}
return isIn(node.left) || isIn(node.right);
}
return false;
}

/**
* Determines whether a arrow function body needs braces
* @param {ASTNode} node The arrow function node.
Expand Down Expand Up @@ -157,6 +175,8 @@ module.exports = {
sourceCode.commentsExistBetween(openingBrace, firstValueToken) ||
sourceCode.commentsExistBetween(lastValueToken, closingBrace);

const isInOp = isIn(blockBody[0].argument);

/*
* Remove tokens around the return value.
* If comments don't exist, remove extra spaces as well.
Expand All @@ -174,15 +194,28 @@ module.exports = {
);
}

let n = node;

if (isInOp) {
while (n.type !== "ForStatement" && n.parent && (n.parent.type !== "BlockStatement" || n.parent.type !== "Program")) {
n = n.parent;
anikethsaha marked this conversation as resolved.
Show resolved Hide resolved
}
}
anikethsaha marked this conversation as resolved.
Show resolved Hide resolved


/*
* If the first token of the reutrn value is `{` or the return value is a sequence expression,
* enclose the return value by parentheses to avoid syntax error.
*/
if (astUtils.isOpeningBraceToken(firstValueToken) || blockBody[0].argument.type === "SequenceExpression") {
fixes.push(
fixer.insertTextBefore(firstValueToken, "("),
fixer.insertTextAfter(lastValueToken, ")")
);
if (astUtils.isOpeningBraceToken(firstValueToken) || blockBody[0].argument.type === "SequenceExpression" || (n.type === "ForStatement" && isInOp)) {

if (firstValueToken.value !== "(") {
anikethsaha marked this conversation as resolved.
Show resolved Hide resolved
fixes.push(
fixer.insertTextBefore(firstValueToken, "("),
fixer.insertTextAfter(lastValueToken, ")")
);
}

}

/*
Expand Down
125 changes: 121 additions & 4 deletions tests/lib/rules/arrow-body-style.js
View file
Open in desktop
Expand Up @@ -19,6 +19,7 @@ const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });

ruleTester.run("arrow-body-style", rule, {
valid: [

"var foo = () => {};",
"var foo = () => 0;",
"var addToB = (a) => { b = b + a };",
Expand All @@ -45,6 +46,121 @@ ruleTester.run("arrow-body-style", rule, {
{ code: "var foo = () => { return { bar: 0 }; };", options: ["as-needed", { requireReturnForObjectLiteral: true }] }
],
invalid: [


{
code: "for (let a = (b, c, d) => { return vb && c in d; }; ;);",
output: "for (let a = (b, c, d) => (vb && c in d); ;);",
errors: [
{
line: 1,
column: 27,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "for (let a = (b, c, d) => { return v in b && c in d; }; ;);",
output: "for (let a = (b, c, d) => (v in b && c in d); ;);",
errors: [
{
line: 1,
column: 27,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "function foo(){ for (let a = (b, c, d) => { return v in b && c in d; }; ;); }",
output: "function foo(){ for (let a = (b, c, d) => (v in b && c in d); ;); }",
errors: [
{
line: 1,
column: 43,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "for ( a = (b, c, d) => { return v in b && c in d; }; ;);",
output: "for ( a = (b, c, d) => (v in b && c in d); ;);",
errors: [
{
line: 1,
column: 24,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "for ( a = (b) => { return (c in d) }; ;);",
output: "for ( a = (b) => (c in d); ;);",
errors: [
{
line: 1,
column: 18,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "for (let a = (b, c, d) => { return vb in dd ; }; ;);",
output: "for (let a = (b, c, d) => (vb in dd ); ;);",
errors: [
{
line: 1,
column: 27,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "for (let a = (b, c, d) => { return vb in c in dd ; }; ;);",
output: "for (let a = (b, c, d) => (vb in c in dd ); ;);",
errors: [
{
line: 1,
column: 27,
messageId: "unexpectedSingleBlock"
}
]
},
{
code: "do{let a = () => {return f in ff}}while(true){}",
output: "do{let a = () => f in ff}while(true){}",
errors: [{
line: 1,
column: 18,
messageId: "unexpectedSingleBlock"
}]
},
{
code: "do{for (let a = (b, c, d) => { return vb in c in dd ; }; ;);}while(true){}",
output: "do{for (let a = (b, c, d) => (vb in c in dd ); ;);}while(true){}",
errors: [{
line: 1,
column: 30,
messageId: "unexpectedSingleBlock"
}]
},
{
code: "scores.map(score => { return x in +(score / maxScore).toFixed(2)});",
output: "scores.map(score => x in +(score / maxScore).toFixed(2));",
errors: [{
line: 1,
column: 21,
messageId: "unexpectedSingleBlock"
}]
},
{
code: "const fn = (a, b) => { return a + x in Number(b) };",
output: "const fn = (a, b) => a + x in Number(b);",
errors: [{
line: 1,
column: 22,
messageId: "unexpectedSingleBlock"
}]
},
{
code: "var foo = () => 0",
output: "var foo = () => {return 0}",
Expand Down Expand Up @@ -368,8 +484,8 @@ ruleTester.run("arrow-body-style", rule, {

// Not fixed; fixing would cause ASI issues.
code:
"var foo = () => { return bar }\n" +
"[1, 2, 3].map(foo)",
"var foo = () => { return bar }\n" +
"[1, 2, 3].map(foo)",
output: null,
options: ["never"],
errors: [
Expand All @@ -378,10 +494,11 @@ ruleTester.run("arrow-body-style", rule, {
},
{


// Not fixed; fixing would cause ASI issues.
code:
"var foo = () => { return bar }\n" +
"(1).toString();",
"var foo = () => { return bar }\n" +
"(1).toString();",
output: null,
options: ["never"],
errors: [
Expand Down