rust-lang / rust-lang/rustfmt

No formatting in arguments passed to macros defined with `=>`

Open
#4,118 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

rustfmt (both stable 1.42.0 and nightly of 12-Apr-2020) does not format arguments of macros defined with =>.

For example, test_arrow!(...) usage below is left as is (with extra whitespaces) after rustfmt, while similar test_comma!(...) is formatted correctly (i.e. original extra space is removed):

macro_rules! test_arrow {
    ($x:expr => $y:expr) => {
        println!("{} {}", $x, $y);
    };
}

macro_rules! test_comma {
    ($x:expr, $y:expr) => {
        println!("{} {}", $x, $y);
    };
}

fn main() {
    test_arrow!("hello" =>   2    + 2);
    test_comma!("hello", 2 + 2);
}

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 supplied test_arrow! and test_comma! macro examples using rustfmt, then trace the macro-formatting entry point that handles their arguments. Done means the test_arrow! invocation formats its extra whitespace consistently with test_comma!.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.