Skip to content

Fix missing inner comments in function expressions#13825

Merged
nicolo-ribaudo merged 2 commits intobabel:mainfrom
overlookmotel:function-inner-comments
Oct 7, 2021
Merged

Fix missing inner comments in function expressions#13825
nicolo-ribaudo merged 2 commits intobabel:mainfrom
overlookmotel:function-inner-comments

Conversation

@overlookmotel
Copy link
Copy Markdown
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-ci
Copy link
Copy Markdown

codesandbox-ci 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 added area: comments pkg: generator PR: Bug Fix 🐛 A type of pull request used for our changelog categories labels Oct 7, 2021
const f = function /*foo*/ () {};
const g = async function /*foo*/ () {};
const h = function* /*foo*/ () {};
const i = async function* /*foo*/ () {};
Copy link
Copy Markdown
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
Copy Markdown
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.

@nicolo-ribaudo
Copy link
Copy Markdown
Member

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

@nicolo-ribaudo nicolo-ribaudo merged commit 6029252 into babel:main Oct 7, 2021
@overlookmotel overlookmotel deleted the function-inner-comments branch October 7, 2021 21:36
@overlookmotel
Copy link
Copy Markdown
Contributor Author

Thanks all!

@github-actions github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Jan 7, 2022
@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.

Labels

area: comments outdated A closed issue/PR that is archived due to age. Recommended to make a new issue pkg: generator PR: Bug Fix 🐛 A type of pull request used for our changelog categories

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants