reasonml / reasonml/reason

Comment at the start of a block causes the next line to wrap

Open
#1,603 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

KIND: FEATURE REQUEST Printer
Dominant language
OCaml
Stars
10.3k
Forks
438
PR merge metrics
No merged PRs in 30d

Description

Possibly related to #1602, but this doesn't break the line above the comment, it breaks the line below.

Simple replication case:

let thing = (b) =>
  if (b) {
    /*
       long comment
       long comment
       long comment
       long comment
       long comment
     */
    String.concat(",", ["a", "b"])
  } else {
    ""
  };

refmt that (in vscode) and you get:

let thing = (b) =>
  if (b) {
    /*
       long comment
       long comment
       long comment
       long comment
       long comment
     */
    String.concat(
      ",",
      ["a", "b"]
    )
  } else {
    ""
  };

Delete a line inside the comment and it stops wrapping.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the example with refmt, using the VS Code formatting path described in the issue. Compare the output when the long comment has five lines with the output after deleting one comment line. Done means the line after a block-start comment no longer wraps unexpectedly while the reported formatting remains correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.