Properly handle removal suggestion rendering

estebank · estebank · commit 20bf5b130fd7 · 2024-07-03T21:03:37.000Z
Do not leave a `+ ` line with only whitespace. In reality, the user will want to remove the entire line.
diff --git a/compiler/rustc_errors/src/emitter.rs b/compiler/rustc_errors/src/emitter.rs
@@ -2273,9 +2273,26 @@ impl HumanEmitter {
                     &normalize_whitespace(last_line),
                     Style::NoStyle,
                 );
-                buffer.puts(*row_num, 0, &self.maybe_anonymized(line_num), Style::LineNumber);
-                buffer.puts(*row_num, max_line_num_len + 1, "+ ", Style::Addition);
-                buffer.append(*row_num, &normalize_whitespace(line_to_add), Style::NoStyle);
+                if !line_to_add.trim().is_empty() {
+                    // Check if after the removal, the line is left with only whitespace. If so, we
+                    // will not show an "addition" line, as removing the whole line is what the user
+                    // would really want.
+                    // For example, for the following:
+                    //   |
+                    // 2 -     .await
+                    // 2 +     (note the left over whitepsace)
+                    //   |
+                    // We really want
+                    //   |
+                    // 2 -     .await
+                    //   |
+                    // *row_num -= 1;
+                    buffer.puts(*row_num, 0, &self.maybe_anonymized(line_num), Style::LineNumber);
+                    buffer.puts(*row_num, max_line_num_len + 1, "+ ", Style::Addition);
+                    buffer.append(*row_num, &normalize_whitespace(line_to_add), Style::NoStyle);
+                } else {
+                    *row_num -= 1;
+                }
             } else {
                 *row_num -= 2;
             }
diff --git a/src/tools/clippy/tests/ui/dbg_macro/dbg_macro.stderr b/src/tools/clippy/tests/ui/dbg_macro/dbg_macro.stderr
@@ -86,7 +86,6 @@ LL |     dbg!();
 help: remove the invocation before committing it to a version control system
    |
 LL -     dbg!();
-LL +     
    |
 
 error: the `dbg!` macro is intended as a debugging tool
@@ -146,7 +145,6 @@ LL |     expand_to_dbg!();
 help: remove the invocation before committing it to a version control system
    |
 LL -             dbg!();
-LL +             
    |
 
 error: the `dbg!` macro is intended as a debugging tool
diff --git a/src/tools/clippy/tests/ui/dbg_macro/dbg_macro_unfixable.stderr b/src/tools/clippy/tests/ui/dbg_macro/dbg_macro_unfixable.stderr
@@ -9,7 +9,6 @@ LL |     dbg!();
 help: remove the invocation before committing it to a version control system
    |
 LL -     dbg!();
-LL +     
    |
 
 error: the `dbg!` macro is intended as a debugging tool
diff --git a/src/tools/clippy/tests/ui/manual_split_once.stderr b/src/tools/clippy/tests/ui/manual_split_once.stderr
@@ -160,12 +160,10 @@ LL |     let (l, r) = "a.b.c".split_once('.').unwrap();
 help: remove the `iter` usages
    |
 LL -     let l = iter.next().unwrap();
-LL +     
    |
 help: remove the `iter` usages
    |
 LL -     let r = iter.next().unwrap();
-LL +     
    |
 
 error: manual implementation of `split_once`
@@ -185,12 +183,10 @@ LL |     let (l, r) = "a.b.c".split_once('.')?;
 help: remove the `iter` usages
    |
 LL -     let l = iter.next()?;
-LL +     
    |
 help: remove the `iter` usages
    |
 LL -     let r = iter.next()?;
-LL +     
    |
 
 error: manual implementation of `rsplit_once`
@@ -210,12 +206,10 @@ LL |     let (l, r) = "a.b.c".rsplit_once('.').unwrap();
 help: remove the `iter` usages
    |
 LL -     let r = iter.next().unwrap();
-LL +     
    |
 help: remove the `iter` usages
    |
 LL -     let l = iter.next().unwrap();
-LL +     
    |
 
 error: manual implementation of `rsplit_once`
@@ -235,12 +229,10 @@ LL |     let (l, r) = "a.b.c".rsplit_once('.')?;
 help: remove the `iter` usages
    |
 LL -     let r = iter.next()?;
-LL +     
    |
 help: remove the `iter` usages
    |
 LL -     let l = iter.next()?;
-LL +     
    |
 
 error: manual implementation of `split_once`
@@ -271,12 +263,10 @@ LL |     let (a, b) = "a.b.c".split_once('.').unwrap();
 help: remove the `iter` usages
    |
 LL -     let a = iter.next().unwrap();
-LL +     
    |
 help: remove the `iter` usages
    |
 LL -     let b = iter.next().unwrap();
-LL +     
    |
 
 error: aborting due to 19 previous errors
diff --git a/src/tools/clippy/tests/ui/needless_if.stderr b/src/tools/clippy/tests/ui/needless_if.stderr
@@ -9,7 +9,6 @@ LL |     if (true) {}
 help: you can remove it
    |
 LL -     if (true) {}
-LL +     
    |
 
 error: this `if` branch is empty
diff --git a/src/tools/clippy/tests/ui/non_canonical_clone_impl.stderr b/src/tools/clippy/tests/ui/non_canonical_clone_impl.stderr
@@ -29,7 +29,6 @@ LL -     fn clone_from(&mut self, source: &Self) {
 LL -         source.clone();
 LL -         *self = source.clone();
 LL -     }
-LL +     
    |
 
 error: non-canonical implementation of `clone` on a `Copy` type
@@ -61,7 +60,6 @@ LL -     fn clone_from(&mut self, source: &Self) {
 LL -         source.clone();
 LL -         *self = source.clone();
 LL -     }
-LL +     
    |
 
 error: aborting due to 4 previous errors
diff --git a/src/tools/clippy/tests/ui/significant_drop_tightening.stderr b/src/tools/clippy/tests/ui/significant_drop_tightening.stderr
@@ -64,7 +64,6 @@ LL +         let rslt0 = mutex.lock().unwrap().abs();
 help: remove separated single usage
    |
 LL -         let rslt0 = lock.abs();
-LL +         
    |
 
 error: temporary with significant `Drop` can be early dropped
@@ -88,7 +87,6 @@ LL +         mutex.lock().unwrap().clear();
 help: remove separated single usage
    |
 LL -         lock.clear();
-LL +         
    |
 
 error: aborting due to 4 previous errors
diff --git a/src/tools/clippy/tests/ui/single_component_path_imports.stderr b/src/tools/clippy/tests/ui/single_component_path_imports.stderr
@@ -20,7 +20,6 @@ LL |     use regex;
 help: remove it entirely
    |
 LL -     use regex;
-LL +     
    |
 
 error: aborting due to 2 previous errors
diff --git a/src/tools/clippy/tests/ui/unused_unit.stderr b/src/tools/clippy/tests/ui/unused_unit.stderr
@@ -72,7 +72,6 @@ LL |         ()
 help: remove the final `()`
    |
 LL -         ()
-LL +         
    |
 
 error: unneeded unit return type
diff --git a/tests/ui/async-await/issue-101715.stderr b/tests/ui/async-await/issue-101715.stderr
@@ -10,7 +10,6 @@ LL |         .await
 help: remove the `.await`
    |
 LL -         .await
-LL +         
    |
 
 error: aborting due to 1 previous error

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,6 @@ LL \| dbg!();`
`86`	`86`	`help: remove the invocation before committing it to a version control system`
`87`	`87`	`\|`
`88`	`88`	`LL - dbg!();`
`89`		`-LL +`
`90`	`89`	`\|`
`91`	`90`
`92`	`91`	error: the `dbg!` macro is intended as a debugging tool
`@@ -146,7 +145,6 @@ LL \| expand_to_dbg!();`
`146`	`145`	`help: remove the invocation before committing it to a version control system`
`147`	`146`	`\|`
`148`	`147`	`LL - dbg!();`
`149`		`-LL +`
`150`	`148`	`\|`
`151`	`149`
`152`	`150`	error: the `dbg!` macro is intended as a debugging tool
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ LL \| dbg!();`
`9`	`9`	`help: remove the invocation before committing it to a version control system`
`10`	`10`	`\|`
`11`	`11`	`LL - dbg!();`
`12`		`-LL +`
`13`	`12`	`\|`
`14`	`13`
`15`	`14`	error: the `dbg!` macro is intended as a debugging tool
Original file line number	Diff line number	Diff line change
`@@ -160,12 +160,10 @@ LL \| let (l, r) = "a.b.c".split_once('.').unwrap();`
`160`	`160`	help: remove the `iter` usages
`161`	`161`	`\|`
`162`	`162`	`LL - let l = iter.next().unwrap();`
`163`		`-LL +`
`164`	`163`	`\|`
`165`	`164`	help: remove the `iter` usages
`166`	`165`	`\|`
`167`	`166`	`LL - let r = iter.next().unwrap();`
`168`		`-LL +`
`169`	`167`	`\|`
`170`	`168`
`171`	`169`	error: manual implementation of `split_once`
`@@ -185,12 +183,10 @@ LL \| let (l, r) = "a.b.c".split_once('.')?;`
`185`	`183`	help: remove the `iter` usages
`186`	`184`	`\|`
`187`	`185`	`LL - let l = iter.next()?;`
`188`		`-LL +`
`189`	`186`	`\|`
`190`	`187`	help: remove the `iter` usages
`191`	`188`	`\|`
`192`	`189`	`LL - let r = iter.next()?;`
`193`		`-LL +`
`194`	`190`	`\|`
`195`	`191`
`196`	`192`	error: manual implementation of `rsplit_once`
`@@ -210,12 +206,10 @@ LL \| let (l, r) = "a.b.c".rsplit_once('.').unwrap();`
`210`	`206`	help: remove the `iter` usages
`211`	`207`	`\|`
`212`	`208`	`LL - let r = iter.next().unwrap();`
`213`		`-LL +`
`214`	`209`	`\|`
`215`	`210`	help: remove the `iter` usages
`216`	`211`	`\|`
`217`	`212`	`LL - let l = iter.next().unwrap();`
`218`		`-LL +`
`219`	`213`	`\|`
`220`	`214`
`221`	`215`	error: manual implementation of `rsplit_once`
`@@ -235,12 +229,10 @@ LL \| let (l, r) = "a.b.c".rsplit_once('.')?;`
`235`	`229`	help: remove the `iter` usages
`236`	`230`	`\|`
`237`	`231`	`LL - let r = iter.next()?;`
`238`		`-LL +`
`239`	`232`	`\|`
`240`	`233`	help: remove the `iter` usages
`241`	`234`	`\|`
`242`	`235`	`LL - let l = iter.next()?;`
`243`		`-LL +`
`244`	`236`	`\|`
`245`	`237`
`246`	`238`	error: manual implementation of `split_once`
`@@ -271,12 +263,10 @@ LL \| let (a, b) = "a.b.c".split_once('.').unwrap();`
`271`	`263`	help: remove the `iter` usages
`272`	`264`	`\|`
`273`	`265`	`LL - let a = iter.next().unwrap();`
`274`		`-LL +`
`275`	`266`	`\|`
`276`	`267`	help: remove the `iter` usages
`277`	`268`	`\|`
`278`	`269`	`LL - let b = iter.next().unwrap();`
`279`		`-LL +`
`280`	`270`	`\|`
`281`	`271`
`282`	`272`	`error: aborting due to 19 previous errors`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ LL \| if (true) {}`
`9`	`9`	`help: you can remove it`
`10`	`10`	`\|`
`11`	`11`	`LL - if (true) {}`
`12`		`-LL +`
`13`	`12`	`\|`
`14`	`13`
`15`	`14`	error: this `if` branch is empty
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,6 @@ LL - fn clone_from(&mut self, source: &Self) {`
`29`	`29`	`LL - source.clone();`
`30`	`30`	`LL - *self = source.clone();`
`31`	`31`	`LL - }`
`32`		`-LL +`
`33`	`32`	`\|`
`34`	`33`
`35`	`34`	error: non-canonical implementation of `clone` on a `Copy` type
`@@ -61,7 +60,6 @@ LL - fn clone_from(&mut self, source: &Self) {`
`61`	`60`	`LL - source.clone();`
`62`	`61`	`LL - *self = source.clone();`
`63`	`62`	`LL - }`
`64`		`-LL +`
`65`	`63`	`\|`
`66`	`64`
`67`	`65`	`error: aborting due to 4 previous errors`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,6 @@ LL + let rslt0 = mutex.lock().unwrap().abs();`
`64`	`64`	`help: remove separated single usage`
`65`	`65`	`\|`
`66`	`66`	`LL - let rslt0 = lock.abs();`
`67`		`-LL +`
`68`	`67`	`\|`
`69`	`68`
`70`	`69`	error: temporary with significant `Drop` can be early dropped
`@@ -88,7 +87,6 @@ LL + mutex.lock().unwrap().clear();`
`88`	`87`	`help: remove separated single usage`
`89`	`88`	`\|`
`90`	`89`	`LL - lock.clear();`
`91`		`-LL +`
`92`	`90`	`\|`
`93`	`91`
`94`	`92`	`error: aborting due to 4 previous errors`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,6 @@ LL \| use regex;`
`20`	`20`	`help: remove it entirely`
`21`	`21`	`\|`
`22`	`22`	`LL - use regex;`
`23`		`-LL +`
`24`	`23`	`\|`
`25`	`24`
`26`	`25`	`error: aborting due to 2 previous errors`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,6 @@ LL \| ()`
`72`	`72`	help: remove the final `()`
`73`	`73`	`\|`
`74`	`74`	`LL - ()`
`75`		`-LL +`
`76`	`75`	`\|`
`77`	`76`
`78`	`77`	`error: unneeded unit return type`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ LL \| .await`
`10`	`10`	help: remove the `.await`
`11`	`11`	`\|`
`12`	`12`	`LL - .await`
`13`		`-LL +`
`14`	`13`	`\|`
`15`	`14`
`16`	`15`	`error: aborting due to 1 previous error`