rust-lang / rust-lang/rustfmt

Formatting `use` statements sometimes leaves behind spaces and newlines

Open
#6,277 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-imports C-bug I-non-idempotency I-poor-formatting I-trailing-whitespace
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Formatting the following code with cargo fmt leaves behind a space and curly braces.

Before:

use core::{
    slice,
    
    fmt::{},
};

(there are 4 spaces on the seemingly empty line)

After:

use core::{ slice};

Expected:

use core::slice;

Here a newline is left behind and rustfmt reports an internal error.

Before:

use core::{
    
    fmt::{Debug, Display},
    slice::{},
};

(there are again 4 spaces on the seemingly empty line)

After:

use core::{
    
    fmt::{Debug, Display},
};

(there are again 4 spaces on the seemingly empty line, rustfmt didn't touch them)

Expected:

use core::fmt::{Debug, Display};

Command output:

$ cargo fmt -- --check file.rs 
Diff in /path/to/file.rs at line 1:
 use core::{
     
     fmt::{Debug, Display},
-    slice::{},
 };
 
error[internal]: left behind trailing whitespace
 --> /path/to/file.rs:2:2:1
  |
2 |     
  | ^^^^
  |

warning: rustfmt has failed to format. See previous 1 errors.

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 with the reproducer in file.rs and run cargo fmt -- --check file.rs to observe the leftover whitespace, braces, and internal error. Trace the rustfmt handling of these use statements, then verify that empty imports are removed, whitespace is cleaned up, and the expected compact import formatting is produced without errors.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.