rust-lang / rust-lang/rustfmt

rustfmt is not idempotent over some blocks that consist of a series of empty statements finished by an expression

Open
#4,748 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-bug P-medium
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Describe the bug

rustfmt is not idempotent over some blocks that consist of a series of empty statements finished by an expression. The first pass strips the empty statements and the second pass applies any applicable transformation to the block such as unwrapping the expression in it or rearranging it into a single line.

To Reproduce

Example input:

fn foo(x: Option<i32>) -> i32 {
    let y = {
        ;
        x
    };
    match y {
        Some(y) => {
            ;
            ;
            y
        }
        None => 0,
    }
}

Calling rustfmt once results in

fn foo(x: Option<i32>) -> i32 {
    let y = {
        x
    };
    match y {
        Some(y) => {
            y
        }
        None => 0,
    }
}

Calling rustfmt on the previous output then results in

fn foo(x: Option<i32>) -> i32 {
    let y = { x };
    match y {
        Some(y) => y,
        None => 0,
    }
}

Expected behavior

rustfmt should return the output of the second pass in the first pass.

Meta

  • rustfmt version: rustfmt 1.4.36-nightly (7de6968e 2021-02-07)
  • From where did you install rustfmt?: rustup
  • How do you run rustfmt?: via rust-analyzer in vscode, but this was tested with rustfmt too

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 running rustfmt twice on the Rust example in the issue and compare the outputs. Trace the block-formatting path responsible for removing empty statements and applying block transformations; done means the second-pass output is produced by the first pass and the behavior is covered by a regression test.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.