rust-lang / rust-lang/rustfmt

Rustfmt produces code with syntax error when r# pattern is used for names in macros

Open
#4,856 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Consider the following Rust code:

macro_rules! example_macro {
    ($r#example: tt) => {
        $r#example
    };
}

fn main() {
    println!(example_macro!("Hello, world!"));
}

It's very strange, but it should work just fine, and print out its greeting. Rustc aggrees, happily compiling and running this code when asked to via cargo run. But, when I run cargo fmt on this code, it gets modified to the following:

macro_rules! example_macro {
    ($r#example: tt) => {
        r#e$xample
    };
}

fn main() {
    println!(example_macro!("Hello, world!"));
}

which, as can be seen in the macro's expansion, is wrong. This seems like a bug, since rustfmt is not supposed to break my code.

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 issue with the Rust macro snippet in the report and compare the source before and after cargo fmt. Trace the formatter behavior for raw-identifier macro metavariables; done means formatting preserves $r#example, and the formatted code still compiles and prints the greeting.

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
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.