rustfmt removes import if it only contains comments
Open
Nobody has claimed this yet.
A-comments
A-imports
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Formatting deletes the import if all of the items are commented out.
Reproducible using rustfmt 1.6.0-nightly (16db2a4b 2023-08-18) and rustfmt 1.5.3-nightly (f4b80cac 2023-06-30). Likely other versions as well.
input
use std::fs::{
// File
};
output
expect
use std::fs::{
// File
};
Originally posted by @okaneco in https://github.com/rust-lang/rustfmt/issues/5852#issuecomment-1667540118
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the provided Rust input and rustfmt versions, then trace rustfmt's handling of imports containing only comments. Done means formatting preserves the use std::fs block and its comment instead of deleting it.
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
- 48/100