rust-lang / rust-lang/rustfmt

Inconsistent formatting between functions and function-like macros

Open
#5,029 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Rustfmt accepts the following code without issues:

pub const FOO: &str = foo("
    foo
    bar
");

But if we are to replace foo with a function-like macro:

pub const FOO: &str = foo!("
    foo
    bar
");

Rustfmt wants to reformat it as:

pub const FOO: &str = foo!(
    "
    foo
    bar
"
);

The resulting formatting is far from beautiful, space inefficient, and inconsistent with how rustfmt handles functions.

This issue is quite annoying in practice for example when code uses the hex-literal crate.

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 two Rust examples with rustfmt and compare how function calls and function-like macros are formatted. No source files or tests are named; done means the macro form preserves the compact string formatting used for the equivalent function call.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.