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

Correctly print parens around in in for heads #16630

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Correctly print parens around in in for heads #16630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions packages/babel-generator/src/generators/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 46,9 @@ export function BlockStatement(this: Printer, node: t.BlockStatement) {
}
}

const exit = this.enterForStatementInit(false);
this.printSequence(node.body, node, { indent: true });
exit();

this.rightBrace(node);
}
Expand Down
2 changes: 2 additions & 0 deletions packages/babel-generator/src/generators/classes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 75,9 @@ export function ClassBody(this: Printer, node: t.ClassBody) {
} else {
this.newline();

const exit = this.enterForStatementInit(false);
this.printSequence(node.body, node, { indent: true });
exit();

if (!this.endsWith(charCodes.lineFeed)) this.newline();

Expand Down
25 changes: 8 additions & 17 deletions packages/babel-generator/src/generators/expressions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 6,6 @@ import {
isNewExpression,
} from "@babel/types";
import type * as t from "@babel/types";
import * as n from "../node/index.ts";

export function UnaryExpression(this: Printer, node: t.UnaryExpression) {
const { operator } = node;
Expand Down Expand Up @@ -97,7 96,9 @@ export function NewExpression(
this.token("?.");
}
this.token("(");
const exit = this.enterForStatementInit(false);
this.printList(node.arguments, node);
exit();
this.rightParens(node);
}

Expand Down Expand Up @@ -179,7 180,9 @@ export function OptionalCallExpression(
this.print(node.typeArguments, node); // Flow

this.token("(");
const exit = this.enterForStatementInit(false);
this.printList(node.arguments, node);
exit();
this.rightParens(node);
}

Expand All @@ -189,7 192,9 @@ export function CallExpression(this: Printer, node: t.CallExpression) {
this.print(node.typeArguments, node); // Flow
this.print(node.typeParameters, node); // TS
this.token("(");
const exit = this.enterForStatementInit(false);
this.printList(node.arguments, node);
exit();
this.rightParens(node);
}

Expand Down Expand Up @@ -251,19 256,7 @@ export function AssignmentPattern(this: Printer, node: t.AssignmentPattern) {
export function AssignmentExpression(
this: Printer,
node: t.AssignmentExpression,
parent: t.Node,
) {
// Somewhere inside a for statement `init` node but doesn't usually
// needs a paren except for `in` expressions: `for (a in b ? a : b;;)`
const parens =
this.inForStatementInitCounter &&
node.operator === "in" &&
!n.needsParens(node, parent);

if (parens) {
this.token("(");
}

this.print(node.left, node);

this.space();
Expand All @@ -275,10 268,6 @@ export function AssignmentExpression(
this.space();

this.print(node.right, node);

if (parens) {
this.token(")");
}
}

export function BindExpression(this: Printer, node: t.BindExpression) {
Expand Down Expand Up @@ -306,9 295,11 @@ export function MemberExpression(this: Printer, node: t.MemberExpression) {
}

if (computed) {
const exit = this.enterForStatementInit(false);
this.token("[");
this.print(node.property, node);
this.token("]");
exit();
} else {
this.token(".");
this.print(node.property, node);
Expand Down
4 changes: 4 additions & 0 deletions packages/babel-generator/src/generators/methods.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 38,8 @@ export function _parameters(
| t.TSFunctionType
| t.TSConstructorType,
) {
const exit = this.enterForStatementInit(false);

const paramLength = parameters.length;
for (let i = 0; i < paramLength; i ) {
this._param(parameters[i], parent);
Expand All @@ -47,6 49,8 @@ export function _parameters(
this.space();
}
}

exit();
}

export function _param(
Expand Down
15 changes: 11 additions & 4 deletions packages/babel-generator/src/generators/statements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 68,12 @@ export function ForStatement(this: Printer, node: t.ForStatement) {
this.space();
this.token("(");

this.inForStatementInitCounter ;
this.print(node.init, node);
this.inForStatementInitCounter--;
{
const exit = this.enterForStatementInit(true);
this.print(node.init, node);
exit();
}

this.token(";");

if (node.test) {
Expand Down Expand Up @@ -107,7 110,11 @@ function ForXStatement(this: Printer, node: t.ForXStatement) {
}
this.noIndentInnerCommentsHere();
this.token("(");
this.print(node.left, node);
{
const exit = isForOf ? null : this.enterForStatementInit(true);
this.print(node.left, node);
exit?.();
}
this.space();
this.word(isForOf ? "of" : "in");
this.space();
Expand Down
6 changes: 6 additions & 0 deletions packages/babel-generator/src/generators/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 25,11 @@ export function ObjectExpression(this: Printer, node: t.ObjectExpression) {
this.token("{");

if (props.length) {
const exit = this.enterForStatementInit(false);
this.space();
this.printList(props, node, { indent: true, statement: true });
this.space();
exit();
}

this.sourceWithOffset("end", node.loc, -1);
Expand Down Expand Up @@ -87,6 89,8 @@ export function ArrayExpression(this: Printer, node: t.ArrayExpression) {

this.token("[");

const exit = this.enterForStatementInit(false);

for (let i = 0; i < elems.length; i ) {
const elem = elems[i];
if (elem) {
Expand All @@ -103,6 107,8 @@ export function ArrayExpression(this: Printer, node: t.ArrayExpression) {
}
}

exit();

this.token("]");
}

Expand Down
11 changes: 8 additions & 3 deletions packages/babel-generator/src/node/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 21,7 @@ type NodeHandler<R> = (
// : t.Node,
parent: t.Node,
stack?: t.Node[],
inForStatementInit?: boolean,
) => R;

export type NodeHandlers<R> = {
Expand All @@ -35,8 36,11 @@ function expandAliases<R>(obj: NodeHandlers<R>) {
map.set(
type,
fn
? function (node, parent, stack) {
return fn(node, parent, stack) ?? func(node, parent, stack);
? function (node, parent, stack, inForInit) {
return (
fn(node, parent, stack, inForInit) ??
func(node, parent, stack, inForInit)
);
}
: func,
);
Expand Down Expand Up @@ -101,6 105,7 @@ export function needsParens(
node: t.Node,
parent: t.Node,
printStack?: t.Node[],
inForInit?: boolean,
) {
if (!parent) return false;

Expand All @@ -116,7 121,7 @@ export function needsParens(
);
}

return expandedParens.get(node.type)?.(node, parent, printStack);
return expandedParens.get(node.type)?.(node, parent, printStack, inForInit);
}

function isDecoratorMemberExpression(node: t.Node): boolean {
Expand Down
15 changes: 4 additions & 11 deletions packages/babel-generator/src/node/parentheses.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,19 252,12 @@ export function TSInstantiationExpression(
export function BinaryExpression(
node: t.BinaryExpression,
parent: t.Node,
stack: unknown,
inForStatementInit: boolean,
): boolean {
// let i = (1 in []);
// for ((1 in []);;);
if (node.operator === "in") {
const parentType = parent.type;
return (
parentType === "VariableDeclarator" ||
parentType === "ForStatement" ||
parentType === "ForInStatement" ||
parentType === "ForOfStatement"
);
}
return false;
// for (var x = (1 in []) in 2);
return node.operator === "in" && inForStatementInit;
}

export function SequenceExpression(
Expand Down
16 changes: 14 additions & 2 deletions packages/babel-generator/src/printer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 119,16 @@ class Printer {
declare _inputMap: TraceMap;

declare format: Format;
inForStatementInitCounter: number = 0;

inForStatementInit: boolean = false;
enterForStatementInit(val: boolean) {
const old = this.inForStatementInit;
if (old === val) return () => {};
Copy link
Member

Choose a reason for hiding this comment

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

Maybe return undefined and then use exit?.() on the caller?

Copy link
Member Author

Choose a reason for hiding this comment

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

Isn't it better to use consistent types, rather than having polymorphic functions? It's trivial for an engine to optimise an empty function call.

this.inForStatementInit = val;
return () => {
this.inForStatementInit = old;
};
}

declare _buf: Buffer;
_printStack: Array<t.Node> = [];
Expand Down Expand Up @@ -658,7 667,7 @@ class Printer {
(parenthesized &&
format.retainFunctionParens &&
nodeType === "FunctionExpression") ||
needsParens(node, parent, this._printStack);
needsParens(node, parent, this._printStack, this.inForStatementInit);

if (
!shouldPrintParens &&
Expand All @@ -683,9 692,11 @@ class Printer {
}
}

let exitInForStatementInit;
if (shouldPrintParens) {
this.token("(");
this._endsWithInnerRaw = false;
exitInForStatementInit = this.enterForStatementInit(false);
}

this._lastCommentLine = 0;
Expand All @@ -707,6 718,7 @@ class Printer {
this._printTrailingComments(node, parent);
this.token(")");
this._noLineTerminator = noLineTerminatorAfter;
exitInForStatementInit();
} else if (noLineTerminatorAfter && !this._noLineTerminator) {
this._noLineTerminator = true;
this._printTrailingComments(node, parent);
Expand Down
47 changes: 47 additions & 0 deletions packages/babel-generator/test/fixtures/parentheses/in-inside-for/input.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,47 @@
for (var a = (b in c) in {});
for (var a = 1 || (b in c) in {});
for (var a = 1 (2 || (b in c)) in {});
for (var a = (() => b in c) in {});
for (var a = 1 || (() => b in c) in {});
for (var a = (() => { b in c; }) in {});
for (var a = [b in c] in {});
for (var a = {b: b in c} in {});
for (var a = (x = b in c) => {} in {});
for (var a = class extends (b in c) {} in {});
for (var a = function (x = b in c) {} in {});

for (var a = (b in c);;);
for (var a = 1 || (b in c);;);
for (var a = 1 (2 || (b in c));;);
for (var a = (() => b in c);;);
for (var a = 1 || (() => b in c);;);
for (var a = (() => { b in c; });;);
for (var a = [b in c];;);
for (var a = {b: b in c};;);
for (var a = (x = b in c) => {};;);
for (var a = class extends (b in c) {};;);
for (var a = function (x = b in c) {};;);

for (var a in (b in c));
for (var a in 1 || (b in c));
for (var a in 1 (2 || (b in c)));
for (var a in (() => b in c));
for (var a in 1 || (() => b in c));
for (var a in (() => { b in c; }));
for (var a in [b in c]);
for (var a in {b: b in c});
for (var a in (x = b in c) => {});
for (var a in class extends (b in c) {});
for (var a in function (x = b in c) {});

for (;a = (b in c););
for (;a = 1 || (b in c););
for (;a = 1 (2 || (b in c)););
for (;a = (() => b in c););
for (;a = 1 || (() => b in c););
for (;a = (() => { b in c; }););
for (;a = [b in c];);
for (;a = {b: b in c};);
for (;a = (x = b in c) => {};);
for (;a = class extends (b in c) {};);
for (;a = function (x = b in c) {};);
4 changes: 4 additions & 0 deletions packages/babel-generator/test/fixtures/parentheses/in-inside-for/options.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,4 @@
{
"sourceType": "script",
"strictMode": false
}
Loading
Loading