rust-lang / rust-lang/rustfmt

Is it possible to display whitespace in output?

Open
#4,839 2 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

I'm working on creating some sample code that is heavily commented (as a teaching tool) and rustfmt was unhappy with trailing whitespace when I was using // on a line by itself to break up long blocks of text. the output showed

         // Payload: The response from the function, or an error object.
-        // 
+        //
         // For our example, we are just going to interact with the payload
         // portion of the response
         Ok(resp) => {

Which is rather confusing until you copy/paste the response and examine that one contains a space and the other doesn't. Would it be possible for rustfmt to identify this whitespace in some way? maybe like with the little dots that some IDEs use?

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 shown rustfmt output with the commented lines containing and omitting trailing whitespace. Read the relevant rustfmt output behavior and determine how whitespace could be made distinguishable without changing the formatted code; done means the difference is clear in the output and covered by a regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.