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.

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

Fix missing inner comments in function expressions #13825

Merged
merged 2 commits into from Oct 7, 2021

Conversation

@overlookmotel
Copy link
Contributor

@overlookmotel overlookmotel commented Oct 6, 2021

Same as #13824 but for function expressions.

Q                       A
Fixed Issues? n/a
Patch: Bug Fix? Yes
Major: Breaking Change? No
Minor: New Feature? No
Tests Added + Pass? Yes
Documentation PR Link n/a
Any Dependency Changes? No
License MIT

Similar to #13819, function expressions with inner comments do not have the comments output by generate(). This PR fixes that.

For async functions, there's some ambiguity as to where the comment should be output i.e.:

x = async /*foo*/ function () {};

or:

x = async function /*foo*/ () {};

I have gone for the latter as for single line comments, putting the comment after async is invalid JS. This is not valid:

x = async // foo
function() {};

whereas this is:

x = async function // foo
() {};

@codesandbox
Copy link

@codesandbox codesandbox bot commented Oct 6, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit d86b098:

Sandbox Source
babel-repl-custom-plugin Configuration
babel-plugin-multi-config Configuration

fedeci
fedeci approved these changes Oct 7, 2021
const f = function /*foo*/ () {};
const g = async function /*foo*/ () {};
const h = function* /*foo*/ () {};
const i = async function* /*foo*/ () {};
Copy link
Contributor

@JLHwung JLHwung Oct 7, 2021

Choose a reason for hiding this comment

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

Can you add a new test case?

const j = function (/*foo*/) {};

it will be printed as

const j = function /*foo*/ () {};

I think we don't have to fix that. It is the nature of using AST for comment attachment targets.

Copy link
Contributor Author

@overlookmotel overlookmotel Oct 7, 2021

Choose a reason for hiding this comment

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

Have pushed another commit adding this case.

I also added cases for other positions of comments in async + generator functions.

const x = async /*foo*/ function () {};
const y = function/*foo*/* () {};

Similarly, these don't come out quite the same as the input, but at least the comment isn't omitted entirely now.

JLHwung
JLHwung approved these changes Oct 7, 2021
JLHwung
JLHwung approved these changes Oct 7, 2021
@nicolo-ribaudo
Copy link
Member

@nicolo-ribaudo nicolo-ribaudo commented Oct 7, 2021

The CI failures seem to be caused by the npm outage.

@nicolo-ribaudo nicolo-ribaudo merged commit 6029252 into babel:main Oct 7, 2021
21 of 24 checks passed
@overlookmotel overlookmotel deleted the function-inner-comments branch Oct 7, 2021
@overlookmotel
Copy link
Contributor Author

@overlookmotel overlookmotel commented Oct 7, 2021

Thanks all!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants