rust-lang / rust-lang/rustfmt

Improve let-chain indentation

Open
#6,636 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-triage
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Current formatted code:

fn too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
-> Option<i32> {
    None
}

fn main() {
    if let Some(x) =
        too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
        && x != 0
    {
        println!("x")
    }
}

If you don't pay attention to the = at the end of the previous line,
you may think that this call returns a bool

Expect improved formatted code:

fn too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
-> Option<i32> {
    None
}

fn main() {
    if let Some(x)
        = too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
        && x != 0
    {
        println!("x")
    }
}

or

fn too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
-> Option<i32> {
    None
}

fn main() {
    if let Some(x) =
            too_long_function_name_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxcxxxxxxxxxxxxxxxxxxxx()
        && x != 0
    {
        println!("x")
    }
}

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

Reproduce the issue with the two Rust examples in the report, then locate the rustfmt code path responsible for formatting let-chain conditions. Decide which of the two proposed layouts is intended and add a regression test for it. Done means the formatter produces the chosen improved indentation without regressing related let-chain formatting.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.