rust-lang / rust-lang/rustfmt

"left behind trailing whitespace" in long patterns

Open
#5,559 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-matches I-poor-formatting I-trailing-whitespace P-low
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Code like this:

fn put_telescope_synctocoordinates(
    PutTelescopeSynctocoordinatesPathParams {
                    
                        device_number,
                    
                }: PutTelescopeSynctocoordinatesPathParams,
) {
}

triggers "left behind trailing whitespace".

I suppose it's because rustfmt tries to put entire param - both pattern and type - on the same line, fails in doing so as that exceeds the max width, and gives up. Instead, it should probably fallback to something like

fn put_telescope_synctocoordinates(
    PutTelescopeSynctocoordinatesPathParams {
      device_number,
    }: PutTelescopeSynctocoordinatesPathParams,
) {
}

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 reported formatting with the long Rust function parameter pattern and the repository's maximum-width settings. Trace the formatter path for long destructuring patterns, add a regression test for the example, and verify that formatting produces the intended indentation without trailing whitespace.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.