reasonml / reasonml/reason

[refmt] Comment on first argument does not stay attached to argument after reformat

Open
#1,741 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Reason try link, then click refmt in top right

Before:

let fn =
    (
      /* Comment about argument 1 */
      longArgumentName1,
      longArgumentName2,
      longArgumentName3,
      longArgumentName4,
      longArgumentName5,
      longArgumentName6,
      longArgumentName7,
      longArgumentName8,
      longArgumentName9,
      longArgumentName10,
      longArgumentName11,
      longArgumentName12
    ) =>
  ();

Actual after refmt:

let fn =
    /* Comment about argument 1 */
    (
      longArgumentName1,
      longArgumentName2,
      longArgumentName3,
      longArgumentName4,
      longArgumentName5,
      longArgumentName6,
      longArgumentName7,
      longArgumentName8,
      longArgumentName9,
      longArgumentName10,
      longArgumentName11,
      longArgumentName12
    ) =>
  ();

Expected after refmt:

let fn =
    (
      /* Comment about argument 1 */
      longArgumentName1,
      longArgumentName2,
      longArgumentName3,
      longArgumentName4,
      longArgumentName5,
      longArgumentName6,
      longArgumentName7,
      longArgumentName8,
      longArgumentName9,
      longArgumentName10,
      longArgumentName11,
      longArgumentName12
    ) =>
  ();

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

Reproduce the example from the linked Reason Try page by clicking refmt and compare the before, actual, and expected output shown in the issue. Trace the refmt formatting entry point and comment handling for function arguments, then add a regression test covering this example. Done means the comment remains immediately before longArgumentName1 after formatting.

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.