Dangling comment not attach to any ast node
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7.1k
- Forks
- 773
- PR merge metrics
- No merged PRs in 30d
Description
Steps to reproduce
esprima.parse('function foo() {return /*comment*/;}', { comment: true })
Expected output
{
"type": "Program",
"body": [
{
"type": "FunctionDeclaration",
"id": {
"type": "Identifier",
"name": "foo"
},
"params": [],
"body": {
"type": "BlockStatement",
"body": [
{
"type": "ReturnStatement",
"argument": null,
"danglingComments": ["comment"], // attach to ReturnStatement ast node
}
]
},
"generator": false,
"expression": false,
"async": false
}
],
"sourceType": "script",
"comments": [
{
"type": "Block",
"value": "comment"
}
]
}
Actual output
{
"type": "Program",
"body": [
{
"type": "FunctionDeclaration",
"id": {
"type": "Identifier",
"name": "foo"
},
"params": [],
"body": {
"type": "BlockStatement",
"body": [
{
"type": "ReturnStatement",
"argument": null
}
]
},
"generator": false,
"expression": false,
"async": false
}
],
"sourceType": "script",
"comments": [
{
"type": "Block",
"value": "comment"
}
]
}
Here "comment" become a "dangling comment".
Relevant references
ReturnStatement:
return ;
In this case, it's true that "comment" is out of both the leading and trailing range of ReturnStatement according to the specification but it will be more convenient if this comment be attached to the ast node.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied esprima.parse call and compare its actual AST with the requested ReturnStatement attachment for the comment. Determine the parser behavior for comments outside a node's leading or trailing range, then add coverage showing the comment is retained in the AST as requested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100