rust-lang / rust-lang/rust-clippy

Warn about trailing whitespace followed by a newline in a string

Open
#6,677 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint E-medium
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

Detect trailing whitespace followed by a newline in a string.

Categories (optional)
  • Kind: style or correctness, not sure

What is the advantage of the recommended code over the original code

Text editors tend to remove whitespace at the end of line which would modify what the code does. Using \x20 instead of a space in such situations will prevent text editor from doing so. Also, whitespace at the end of line is invisible to humans making for very confusing code.

Drawbacks

None.

Example
fn main() {
    println!("    
        Hello, world!
    ");
}

Could be written as:

fn main() {
    println!("   \x20
        Hello, world!
    ");
}

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 searching the rust-clippy repository for existing string or style lints and their test fixtures. The work is complete when a lint detects trailing whitespace immediately before a newline in a string and the behavior is covered by tests for the examples described in this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.