rust-lang / rust-lang/rustfmt

Allow `reason` attribute for `#[rusfmt::skip]`

Open
#6,625 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Right now placing reason parameter in rustfmt::skip macro

#[rustfmt::skip(reason = "text indentation")]

will cause LSP to still format block.

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 tracing rustfmt's handling of the rustfmt::skip attribute and the LSP formatting path, focusing on how the reason parameter is parsed. Done means #[rustfmt::skip(reason = "text indentation")] is accepted and the annotated block remains unformatted through LSP; add or update coverage for this behavior.

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.