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

Collect comments around parentheses in expressions #13803

Merged
merged 5 commits into from Oct 5, 2021
Merged

Collect comments around parentheses in expressions #13803

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ae97220
Allow putting leading comments before parentheses in expressions
nicolo-ribaudo Sep 30, 2021
62ff104
Review
nicolo-ribaudo Oct 2, 2021
0d1c954
Update tests
nicolo-ribaudo Oct 2, 2021
7ba50d0
Fix perf
nicolo-ribaudo Oct 4, 2021
418cc3a
Update packages/babel-parser/src/parser/comments.js
nicolo-ribaudo Oct 5, 2021
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
17 changes: 17 additions & 0 deletions .../regression/comment-before-parentheses-return-arg-createParenthesizedExpressions/input.js
View file
Open in desktop
@@ -0,0 +1,17 @@
function assertElement(assertFn, shouldBeElement, opt_message) {
return /** @type {!Ele ment} */ (
assertType_(
assertFn,
shouldBeElement,
isElement(shouldBeElement),
'Element expected',
opt_message
)
);
}

const slot = /** @type {!HTMLSlotElement} */ (e.target);

assertElement(
/** @type {Element} */ (el),
);
4 changes: 4 additions & 0 deletions ...ression/comment-before-parentheses-return-arg-createParenthesizedExpressions/options.json
View file
Open in desktop
@@ -0,0 +1,4 @@
{
"retainLines": true,
"createParenthesizedExpressions": true
}
16 changes: 16 additions & 0 deletions ...regression/comment-before-parentheses-return-arg-createParenthesizedExpressions/output.js
View file
Open in desktop
@@ -0,0 +1,16 @@
function assertElement(assertFn, shouldBeElement, opt_message) {
return (/** @type {!Ele ment} */
assertType_(
assertFn,
shouldBeElement,
isElement(shouldBeElement),
'Element expected',
opt_message));


}

const slot = /** @type {!HTMLSlotElement} */e.target;

assertElement(
/** @type {Element} */el);
17 changes: 17 additions & 0 deletions ...s/babel-generator/test/fixtures/regression/comment-before-parentheses-return-arg/input.js
View file
Open in desktop
@@ -0,0 +1,17 @@
function assertElement(assertFn, shouldBeElement, opt_message) {
nicolo-ribaudo marked this conversation as resolved.
Show resolved Hide resolved
return /** @type {!Ele ment} */ (
assertType_(
assertFn,
shouldBeElement,
isElement(shouldBeElement),
'Element expected',
opt_message
)
);
}

const slot = /** @type {!HTMLSlotElement} */ (e.target);

assertElement(
/** @type {Element} */ (el),
);
13 changes: 13 additions & 0 deletions .../babel-generator/test/fixtures/regression/comment-before-parentheses-return-arg/output.js
View file
Open in desktop
@@ -0,0 +1,13 @@
function assertElement(assertFn, shouldBeElement, opt_message) {
return (
/** @type {!Ele ment} */
assertType_(assertFn, shouldBeElement, isElement(shouldBeElement), 'Element expected', opt_message)
);
}

const slot =
/** @type {!HTMLSlotElement} */
e.target;
assertElement(
/** @type {Element} */
el);
55 changes: 52 additions & 3 deletions packages/babel-parser/src/parser/comments.js
View file
Open in desktop
Expand Up @@ -26,6 +26,7 @@ export type CommentWhitespace = {
trailingNode: Node | null,
containingNode: Node | null,
};

/**
* Merge comments with node's trailingComments or assign comments to be
* trailingComments. New comments will be placed before old comments
Expand All @@ -42,6 +43,22 @@ function setTrailingComments(node: Node, comments: Array<Comment>) {
}
}

/**
* Merge comments with node's leadingComments or assign comments to be
* leadingComments. New comments will be placed before old comments
* because the commentStack is enumerated reversely.
*
* @param {Node} node
* @param {Array<Comment>} comments
*/
function setLeadingComments(node: Node, comments: Array<Comment>) {
if (node.leadingComments === undefined) {
node.leadingComments = comments;
} else {
node.leadingComments.unshift(...comments);
}
}

/**
* Merge comments with node's innerComments or assign comments to be
* innerComments. New comments will be placed before old comments
Expand All @@ -50,10 +67,10 @@ function setTrailingComments(node: Node, comments: Array<Comment>) {
* @param {Node} node
* @param {Array<Comment>} comments
*/
export function setInnerComments(node: Node, comments: Array<Comment> | void) {
export function setInnerComments(node: Node, comments: Array<Comment>) {
if (node.innerComments === undefined) {
node.innerComments = comments;
} else if (comments !== undefined) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just to align the signature to the other two functions: since they are really similar it's easier to keep the implementation the same.

} else {
node.innerComments.unshift(...comments);
}
}
Expand Down Expand Up @@ -149,7 +166,7 @@ export default class CommentsParser extends BaseParser {
setTrailingComments(commentWS.leadingNode, comments);
}
if (commentWS.trailingNode !== null) {
commentWS.trailingNode.leadingComments = comments;
setLeadingComments(commentWS.trailingNode, comments);
}
} else {
/*:: invariant(commentWS.containingNode !== null) */
Expand Down Expand Up @@ -238,4 +255,36 @@ export default class CommentsParser extends BaseParser {
commentWS.leadingNode = null;
}
}

/**
* Attach a node to the comment whitespaces right before/after
* the given range.
*
* This is used to propertly attach comments aroung parenthesized
nicolo-ribaudo marked this conversation as resolved.
Show resolved Hide resolved
* expressions as leading/trailing comments of the inner expression.
*
* @param {Node} node
* @param {number} start
* @param {number} end
*/
takeSurroundingComments(node: Node, start: number, end: number) {
const { commentStack } = this.state;
const commentStackLength = commentStack.length;
if (commentStackLength === 0) return;
let i = commentStackLength - 1;

for (; i >= 0; i--) {
const commentWS = commentStack[i];
const commentEnd = commentWS.end;
const commentStart = commentWS.start;

if (commentStart === end) {
commentWS.leadingNode = node;
} else if (commentEnd === start) {
commentWS.trailingNode = node;
} else if (commentEnd < start) {
break;
}
}
}
}
11 changes: 9 additions & 2 deletions packages/babel-parser/src/parser/expression.js
View file
Open in desktop
Expand Up @@ -1023,9 +1023,13 @@ export default class ExpressionParser extends LValParser {
call.extra?.trailingComma,
);
// mark inner comments of `async()` as inner comments of `async () =>`
setInnerComments(node, call.innerComments);
if (call.innerComments) {
setInnerComments(node, call.innerComments);
}
// mark trailing comments of `async` to be inner comments
setInnerComments(node, call.callee.trailingComments);
if (call.callee.trailingComments) {
setInnerComments(node, call.callee.trailingComments);
}
return node;
}

Expand Down Expand Up @@ -1738,6 +1742,9 @@ export default class ExpressionParser extends LValParser {
if (!this.options.createParenthesizedExpressions) {
this.addExtra(val, "parenthesized", true);
this.addExtra(val, "parenStart", startPos);

this.takeSurroundingComments(val, startPos, this.state.lastTokEnd);

return val;
}

Expand Down
1 change: 1 addition & 0 deletions packages/babel-parser/test/fixtures/comments/basic/nested-parentheses/input.js
View file
Open in desktop
@@ -0,0 +1 @@
1 + /* 0 */(/* 1 */(/* 2 */(/* 3 */i/* 4 */)/* 5 */)/* 6 */)/* 7 */;
128 changes: 128 additions & 0 deletions packages/babel-parser/test/fixtures/comments/basic/nested-parentheses/output.json
View file
Open in desktop
@@ -0,0 +1,128 @@
{
"type": "File",
"start":0,"end":68,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":68}},
"program": {
"type": "Program",
"start":0,"end":68,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":68}},
"sourceType": "script",
"interpreter": null,
"body": [
{
"type": "ExpressionStatement",
"start":0,"end":68,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":68}},
"expression": {
"type": "BinaryExpression",
"start":0,"end":60,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":60}},
"left": {
"type": "NumericLiteral",
"start":0,"end":1,"loc":{"start":{"line":1,"column":0},"end":{"line":1,"column":1}},
"extra": {
"rawValue": 1,
"raw": "1"
},
"value": 1
},
"operator": "+",
"right": {
"type": "Identifier",
"start":35,"end":36,"loc":{"start":{"line":1,"column":35},"end":{"line":1,"column":36},"identifierName":"i"},
"name": "i",
"extra": {
"parenthesized": true,
"parenStart": 11
},
"trailingComments": [
{
"type": "CommentBlock",
"value": " 4 ",
"start":36,"end":43,"loc":{"start":{"line":1,"column":36},"end":{"line":1,"column":43}}
},
{
"type": "CommentBlock",
"value": " 5 ",
"start":44,"end":51,"loc":{"start":{"line":1,"column":44},"end":{"line":1,"column":51}}
},
{
"type": "CommentBlock",
"value": " 6 ",
"start":52,"end":59,"loc":{"start":{"line":1,"column":52},"end":{"line":1,"column":59}}
}
],
"leadingComments": [
{
"type": "CommentBlock",
"value": " 0 ",
"start":4,"end":11,"loc":{"start":{"line":1,"column":4},"end":{"line":1,"column":11}}
},
{
"type": "CommentBlock",
"value": " 1 ",
"start":12,"end":19,"loc":{"start":{"line":1,"column":12},"end":{"line":1,"column":19}}
},
{
"type": "CommentBlock",
"value": " 2 ",
"start":20,"end":27,"loc":{"start":{"line":1,"column":20},"end":{"line":1,"column":27}}
},
{
"type": "CommentBlock",
"value": " 3 ",
"start":28,"end":35,"loc":{"start":{"line":1,"column":28},"end":{"line":1,"column":35}}
}
]
},
"trailingComments": [
{
"type": "CommentBlock",
"value": " 7 ",
"start":60,"end":67,"loc":{"start":{"line":1,"column":60},"end":{"line":1,"column":67}}
}
]
}
}
],
"directives": []
},
"comments": [
{
"type": "CommentBlock",
"value": " 0 ",
"start":4,"end":11,"loc":{"start":{"line":1,"column":4},"end":{"line":1,"column":11}}
},
{
"type": "CommentBlock",
"value": " 1 ",
"start":12,"end":19,"loc":{"start":{"line":1,"column":12},"end":{"line":1,"column":19}}
},
{
"type": "CommentBlock",
"value": " 2 ",
"start":20,"end":27,"loc":{"start":{"line":1,"column":20},"end":{"line":1,"column":27}}
},
{
"type": "CommentBlock",
"value": " 3 ",
"start":28,"end":35,"loc":{"start":{"line":1,"column":28},"end":{"line":1,"column":35}}
},
{
"type": "CommentBlock",
"value": " 4 ",
"start":36,"end":43,"loc":{"start":{"line":1,"column":36},"end":{"line":1,"column":43}}
},
{
"type": "CommentBlock",
"value": " 5 ",
"start":44,"end":51,"loc":{"start":{"line":1,"column":44},"end":{"line":1,"column":51}}
},
{
"type": "CommentBlock",
"value": " 6 ",
"start":52,"end":59,"loc":{"start":{"line":1,"column":52},"end":{"line":1,"column":59}}
},
{
"type": "CommentBlock",
"value": " 7 ",
"start":60,"end":67,"loc":{"start":{"line":1,"column":60},"end":{"line":1,"column":67}}
}
]
}
22 changes: 10 additions & 12 deletions packages/babel-parser/test/fixtures/comments/basic/sequence-expression/output.json
View file
Open in desktop
Expand Up @@ -24,22 +24,15 @@
"start":77,"end":84,"loc":{"start":{"line":1,"column":77},"end":{"line":1,"column":84}}
}
],
"innerComments": [
{
"type": "CommentBlock",
"value": " 2 ",
"start":9,"end":16,"loc":{"start":{"line":1,"column":9},"end":{"line":1,"column":16}}
},
{
"type": "CommentBlock",
"value": " 8 ",
"start":68,"end":75,"loc":{"start":{"line":1,"column":68},"end":{"line":1,"column":75}}
}
],
"expression": {
"type": "SequenceExpression",
"start":27,"end":47,"loc":{"start":{"line":1,"column":27},"end":{"line":1,"column":47}},
"leadingComments": [
{
"type": "CommentBlock",
"value": " 2 ",
"start":9,"end":16,"loc":{"start":{"line":1,"column":9},"end":{"line":1,"column":16}}
},
{
"type": "CommentBlock",
"value": " 3 ",
Expand All @@ -51,6 +44,11 @@
"type": "CommentBlock",
"value": " 7 ",
"start":58,"end":65,"loc":{"start":{"line":1,"column":58},"end":{"line":1,"column":65}}
},
{
"type": "CommentBlock",
"value": " 8 ",
"start":68,"end":75,"loc":{"start":{"line":1,"column":68},"end":{"line":1,"column":75}}
}
],
"extra": {
Expand Down
5 changes: 5 additions & 0 deletions packages/babel-parser/test/fixtures/comments/regression/13750/input.js
View file
Open in desktop
@@ -0,0 +1,5 @@
if (args[0] === 1 || /* istanbul ignore next */ (args[0] === 2 || args[0] === 3)) {
nicolo-ribaudo marked this conversation as resolved.
Show resolved Hide resolved
output = args[0] + 10;
} else {
output = 20;
}