Comments are ignored when removing line breaks
Open
Nobody has claimed this yet.
area:comments
lang:javascript
status:needs investigation
- Dominant language
- JavaScript
- Stars
- 52.3k
- Forks
- 5k
- Avg merge
- 19h 2m
- Merged PRs (30d)
- 117
Description
Prettier 3.0.1
Playground link
--parser babel
Input:
if (some_moderately_long_statement && some_other_statement)
return // some extremely long comment that explains what we're doing
Output:
if (some_moderately_long_statement && some_other_statement) return; // some extremely long comment that explains what we're doing
Expected behavior:
Removing the line break makes the line exceed print width by a considerable margin. It should probably keep the line break here?
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
Reproduce the report in the linked Prettier Playground using the shown JSX input and the babel parser, then compare the current output with the expected behavior. Trace the formatting path responsible for removing the line break before the return comment; done means the break is retained when removing it would make the line substantially exceed print width.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100