rust-lang / rust-lang/rustfmt

Divergent case: rustfmt increases indentation on each invocation in rustfmt::skip'd block

Open
#5,555 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-macros A-rustfmt::skip P-low
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

In the following example, rustfmt increases the indentation of the line with }); by one level each time it is run:

macro_rules! pwm_timer_init {
    ($tim:expr) => {{
        let tim = $tim;
        #[rustfmt::skip]
        tim.ccmr1_output().write(|w| {
            w
                .oc1pe().enabled()
                .oc1m().pwm_mode1()
                .oc2pe().enabled()
                .oc2m().pwm_mode1()
        });
    }};
}

This is also visible in the nightly version of the playground, though I found it with rustfmt 1.5.1-stable (4b91a6e 2022-08-08).

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 with the macro_rules example in the issue and reproduce it using the linked Rust Playground or rustfmt 1.5.1-stable. Run rustfmt repeatedly on the rustfmt::skip'd block and trace the formatting behavior responsible for the closing }); line. Done means repeated invocations no longer increase its indentation.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.