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

Skip newlines around inline #__PURE__ annotations #11133

Merged
merged 2 commits into from Feb 13, 2020
Merged

Skip newlines around inline #__PURE__ annotations #11133

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68b4a9b
Skip newlines around #__PURE__ annotations
nicolo-ribaudo Feb 12, 2020
080b9eb
Update tests
nicolo-ribaudo Feb 12, 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
42 changes: 29 additions & 13 deletions packages/babel-generator/src/printer.js
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@ import * as generatorFunctions from "./generators";
const SCIENTIFIC_NOTATION = /e/i;
const ZERO_DECIMAL_INTEGER = /\.0+$/;
const NON_DECIMAL_LITERAL = /^0[box]/;
const PURE_ANNOTATION_RE = /^\s*[@#]__PURE__\s*$/;

export type Format = {
shouldPrintComment: (comment: string) => boolean,
Expand Down Expand Up @@ -477,7 +478,11 @@ export default class Printer {
}

_printLeadingComments(node) {
this._printComments(this._getComments(true, node));
this._printComments(
this._getComments(true, node),
// Don't add leading/trailing new lines to #__PURE__ annotations
true,
);
}

printInnerComments(node, indent = true) {
Expand Down Expand Up @@ -532,7 +537,7 @@ export default class Printer {
);
}

_printComment(comment) {
_printComment(comment, skipNewLines?: boolean) {
if (!this.format.shouldPrintComment(comment.value)) return;

// Some plugins use this to mark comments as removed using the AST-root 'comments' property,
Expand All @@ -549,12 +554,12 @@ export default class Printer {

const isBlockComment = comment.type === "CommentBlock";

// Always add a newline before a block comment
this.newline(
this._buf.hasContent() && !this._noLineTerminator && isBlockComment
? 1
: 0,
);
// Add a newline before and after a block comment, unless explicitly
// disallowed
const printNewLines =
isBlockComment && !skipNewLines && !this._noLineTerminator;

if (printNewLines && this._buf.hasContent()) this.newline(1);

if (!this.endsWith("[") && !this.endsWith("{")) this.space();

Expand Down Expand Up @@ -584,15 +589,26 @@ export default class Printer {
this._append(val);
});

// Always add a newline after a block comment
this.newline(isBlockComment && !this._noLineTerminator ? 1 : 0);
if (printNewLines) this.newline(1);
}

_printComments(comments?: Array<Object>) {
_printComments(comments?: Array<Object>, inlinePureAnnotation?: boolean) {
if (!comments || !comments.length) return;

for (const comment of comments) {
this._printComment(comment);
if (
inlinePureAnnotation &&
comments.length === 1 &&
PURE_ANNOTATION_RE.test(comments[0].value)
) {
this._printComment(
comments[0],
// Keep newlines if the comment marks a standalone call
this._buf.hasContent() && !this.endsWith("\n"),
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 for cases like https://github.com/babel/babel/blob/master/packages/babel-plugin-proposal-async-generator-functions/test/fixtures/async-generators/expression/output.js#L1, where I think that we should keep the \n.

);
} else {
for (const comment of comments) {
this._printComment(comment);
}
}
}
}
Expand Down