rust-lang / rust-lang/rustfmt

trailing comma after function call chains may need a comment barrier

Open
#5,165 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-call-chains A-comments P-low
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

When given a function call chain, and a comment rustfmt will move the comma above the comment,
which cause

fn main() {
    ().foo(
        ().foo
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            .foo()
            //.foo()
            ,
    )
}

afterwords the last line looks like:
.foo(), //.foo()

Which moves the comment from the first parameter, to the second (nonexistent!) parameter if one were to uncomment it,
This makes the addition of a comment, followed by rustfmt, followed by the removal of a comment syntactically invalid which can be inconvenient.

Contributor guide

Open the contributing guide

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 formatting change with the function-call chain and commented-out .foo() shown in the issue. Trace the formatter entry point that handles trailing commas and comments, then add coverage for this example; done means formatting preserves a comment barrier so uncommenting the call remains syntactically valid.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.