Special-case item attributes in the suggestion output

Author: estebank

compiler/rustc_errors/src/emitter.rs

@@ -1886,6 +1886,7 @@ impl EmitterWriter {
             }
             let mut unhighlighted_lines = Vec::new();
             let mut last_pos = 0;
+            let mut is_item_attribute = false;
             for (line_pos, (line, highlight_parts)) in lines.by_ref().zip(highlights).enumerate() {
                 last_pos = line_pos;
                 debug!(%line_pos, %line, ?highlight_parts);
@@ -1895,6 +1896,12 @@ impl EmitterWriter {
                     unhighlighted_lines.push((line_pos, line));
                     continue;
                 }
+                if highlight_parts.len() == 1
+                    && line.trim().starts_with("#[")
+                    && line.trim().ends_with(']')
+                {
+                    is_item_attribute = true;
+                }
 
                 match unhighlighted_lines.len() {
                     0 => (),
@@ -1971,11 +1978,13 @@ impl EmitterWriter {
                     is_multiline,
                 )
             }
-            if let DisplaySuggestion::Add = show_code_change {
+            if let DisplaySuggestion::Add = show_code_change && is_item_attribute {
                 // The suggestion adds an entire line of code, ending on a newline, so we'll also
                 // print the *following* line, to provide context of what we're advicing people to
                 // do. Otherwise you would only see contextless code that can be confused for
                 // already existing code, despite the colors and UI elements.
+                // We special case `#[derive(_)]\n` and other attribute suggestions, because those
+                // are the ones where context is most useful.
                 let file_lines = sm
                     .span_to_lines(span.primary_span().unwrap().shrink_to_hi())
                     .expect("span_to_lines failed when emitting suggestion");

src/tools/clippy/tests/ui/crashes/ice-6252.stderr

@@ -7,13 +7,10 @@ LL |     _n: PhantomData,
 help: consider importing one of these items
    |
 LL + use core::marker::PhantomData;
-LL | trait TypeVal<T> {
    |
 LL + use serde::__private::PhantomData;
-LL | trait TypeVal<T> {
    |
 LL + use std::marker::PhantomData;
-LL | trait TypeVal<T> {
    |
 
 error[E0412]: cannot find type `VAL` in this scope

src/tools/clippy/tests/ui/new_without_default.stderr

@@ -14,7 +14,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl Foo {
    |
 
 error: you should consider adding a `Default` implementation for `Bar`
@@ -32,7 +31,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl Bar {
    |
 
 error: you should consider adding a `Default` implementation for `LtKo<'c>`
@@ -50,7 +48,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl<'c> LtKo<'c> {
    |
 
 error: you should consider adding a `Default` implementation for `NewNotEqualToDerive`
@@ -68,7 +65,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl NewNotEqualToDerive {
    |
 
 error: you should consider adding a `Default` implementation for `FooGenerics<T>`
@@ -86,7 +82,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl<T> FooGenerics<T> {
    |
 
 error: you should consider adding a `Default` implementation for `BarGenerics<T>`
@@ -104,7 +99,6 @@ LL +     fn default() -> Self {
 LL +         Self::new()
 LL +     }
 LL + }
-LL | impl<T: Copy> BarGenerics<T> {
    |
 
 error: you should consider adding a `Default` implementation for `Foo<T>`

tests/ui/coherence/coherence_inherent.stderr

@@ -8,7 +8,6 @@ LL |         s.the_fn();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL +     use Lib::TheTrait;
-LL |     use Lib::TheStruct;
    |
 
 error: aborting due to previous error

tests/ui/coherence/coherence_inherent_cc.stderr

@@ -8,7 +8,6 @@ LL |         s.the_fn();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL +     use coherence_inherent_cc_lib::TheTrait;
-LL |     use coherence_inherent_cc_lib::TheStruct;
    |
 
 error: aborting due to previous error

tests/ui/const-generics/generic_const_exprs/issue-94287.stderr

@@ -9,7 +9,6 @@ help: consider enabling this feature
   --> $DIR/issue-94287.rs:1:1
    |
 LL + #![feature(generic_const_exprs)]
-LL | #![feature(generic_const_exprs)]
    |
 
 error: aborting due to previous error

tests/ui/const-generics/issues/issue-82956.stderr

@@ -7,16 +7,12 @@ LL |         let mut iter = IntoIter::new(self);
 help: consider importing one of these items
    |
 LL + use std::array::IntoIter;
-LL | pub struct ConstCheck<const CHECK: bool>;
    |
 LL + use std::collections::binary_heap::IntoIter;
-LL | pub struct ConstCheck<const CHECK: bool>;
    |
 LL + use std::collections::btree_map::IntoIter;
-LL | pub struct ConstCheck<const CHECK: bool>;
    |
 LL + use std::collections::btree_set::IntoIter;
-LL | pub struct ConstCheck<const CHECK: bool>;
    |
      and 8 other candidates
 

tests/ui/derived-errors/issue-31997-1.stderr

@@ -7,7 +7,6 @@ LL |     let mut map = HashMap::new();
 help: consider importing this struct
    |
 LL + use std::collections::HashMap;
-LL | use std::io::prelude::*;
    |
 
 error: aborting due to previous error

tests/ui/did_you_mean/issue-56028-there-is-an-enum-variant.stderr

@@ -25,16 +25,12 @@ LL | fn setup() -> Set { Set }
 help: consider importing one of these items
    |
 LL + use AffixHeart::Set;
-LL | enum PutDown { Set }
    |
 LL + use CauseToBe::Set;
-LL | enum PutDown { Set }
    |
 LL + use Determine::Set;
-LL | enum PutDown { Set }
    |
 LL + use PutDown::Set;
-LL | enum PutDown { Set }
    |
      and 3 other candidates
 

tests/ui/hygiene/globs.stderr

@@ -14,7 +14,6 @@ LL |         g();
 help: consider importing this function
    |
 LL + use foo::f;
-LL | mod foo {
    |
 
 error[E0425]: cannot find function `g` in this scope
@@ -41,7 +40,6 @@ LL |     f();
 help: consider importing this function
    |
 LL + use bar::g;
-LL | mod foo {
    |
 
 error[E0425]: cannot find function `f` in this scope

tests/ui/hygiene/no_implicit_prelude.stderr

@@ -11,7 +11,6 @@ LL |         Vec::new();
 help: consider importing this struct
    |
 LL +     use std::vec::Vec;
-LL |     pub macro m() { Vec::<i32>::new(); ().clone() }
    |
 
 error[E0599]: no method named `clone` found for unit type `()` in the current scope
@@ -28,7 +27,6 @@ LL |         ().clone()
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL +     use std::clone::Clone;
-LL |     pub macro m() { Vec::<i32>::new(); ().clone() }
    |
 
 error: aborting due to 2 previous errors

tests/ui/hygiene/trait_items.stderr

@@ -15,7 +15,6 @@ LL |     pub macro m() { ().f() }
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL +     use foo::T;
-LL |     use foo::*;
    |
 
 error: aborting due to previous error

tests/ui/impl-trait/no-method-suggested-traits.stderr

@@ -8,16 +8,12 @@ LL |     1u32.method();
 help: the following traits are implemented but not in scope; perhaps add a `use` for one of them:
    |
 LL + use foo::Bar;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::Reexported;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::foo::PubPub;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::qux::PrivPub;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for struct `Rc<&mut Box<&u32>>` in the current scope
@@ -30,16 +26,12 @@ LL |     std::rc::Rc::new(&mut Box::new(&1u32)).method();
 help: the following traits are implemented but not in scope; perhaps add a `use` for one of them:
    |
 LL + use foo::Bar;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::Reexported;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::foo::PubPub;
-LL | extern crate no_method_suggested_traits;
    |
 LL + use no_method_suggested_traits::qux::PrivPub;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for type `char` in the current scope
@@ -55,7 +47,6 @@ LL |     'a'.method();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use foo::Bar;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for struct `Rc<&mut Box<&char>>` in the current scope
@@ -68,7 +59,6 @@ LL |     std::rc::Rc::new(&mut Box::new(&'a')).method();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use foo::Bar;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for type `i32` in the current scope
@@ -86,7 +76,6 @@ LL |         fn method(&self) {}
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use no_method_suggested_traits::foo::PubPub;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for struct `Rc<&mut Box<&i32>>` in the current scope
@@ -99,7 +88,6 @@ LL |     std::rc::Rc::new(&mut Box::new(&1i32)).method();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use no_method_suggested_traits::foo::PubPub;
-LL | extern crate no_method_suggested_traits;
    |
 
 error[E0599]: no method named `method` found for struct `Foo` in the current scope

tests/ui/impl-trait/universal_wrong_bounds.stderr

@@ -7,7 +7,6 @@ LL | fn wants_debug(g: impl Debug) { }
 help: consider importing this trait instead
    |
 LL + use std::fmt::Debug;
-LL | use std::fmt::Display;
    |
 
 error[E0404]: expected trait, found derive macro `Debug`
@@ -19,7 +18,6 @@ LL | fn wants_display(g: impl Debug) { }
 help: consider importing this trait instead
    |
 LL + use std::fmt::Debug;
-LL | use std::fmt::Display;
    |
 
 error: aborting due to 2 previous errors

tests/ui/imports/glob-resolve1.stderr

@@ -61,7 +61,6 @@ LL |     import();
 help: consider importing this function
    |
 LL + use other::import;
-LL | use bar::*;
    |
 
 error[E0412]: cannot find type `A` in this scope

tests/ui/imports/issue-38293.stderr

@@ -13,7 +13,6 @@ LL |     baz();
 help: consider importing this function instead
    |
 LL + use bar::baz;
-LL | use foo::f::{self};
    |
 
 error: aborting due to 2 previous errors

tests/ui/imports/issue-4366-2.stderr

@@ -19,7 +19,6 @@ LL |     foo();
 help: consider importing this function instead
    |
 LL + use foo::foo;
-LL | use m1::*;
    |
 
 error: aborting due to 2 previous errors

tests/ui/imports/issue-4366.stderr

@@ -7,7 +7,6 @@ LL |         fn sub() -> isize { foo(); 1 }
 help: consider importing this function
    |
 LL +         use foo::foo;
-LL |         use a::b::*;
    |
 
 error: aborting due to previous error

tests/ui/imports/overlapping_pub_trait.stderr

@@ -13,7 +13,6 @@ LL |     pub trait Tr { fn method(&self); }
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use overlapping_pub_trait_source::m::Tr;
-LL | extern crate overlapping_pub_trait_source;
    |
 
 error: aborting due to previous error

tests/ui/imports/unnamed_pub_trait.stderr

@@ -13,7 +13,6 @@ LL |     pub trait Tr { fn method(&self); }
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use unnamed_pub_trait_source::prelude::*; // trait Tr
-LL | extern crate unnamed_pub_trait_source;
    |
 
 error: aborting due to previous error

tests/ui/issues/issue-10465.stderr

@@ -8,7 +8,6 @@ LL |             b.foo();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL +         use a::A;
-LL |         use b::B;
    |
 
 error: aborting due to previous error

tests/ui/issues/issue-17546.stderr

@@ -25,16 +25,12 @@ LL |     fn new() -> Result<foo::MyEnum, String> {
 help: consider importing one of these items instead
    |
 LL +     use std::fmt::Result;
-LL |     use foo::MyEnum::Result;
    |
 LL +     use std::io::Result;
-LL |     use foo::MyEnum::Result;
    |
 LL +     use std::result::Result;
-LL |     use foo::MyEnum::Result;
    |
 LL +     use std::thread::Result;
-LL |     use foo::MyEnum::Result;
    |
 
 error[E0573]: expected type, found variant `Result`
@@ -46,16 +42,12 @@ LL | fn new() -> Result<foo::MyEnum, String> {
 help: consider importing one of these items instead
    |
 LL + use std::fmt::Result;
-LL | use foo::MyEnum::Result;
    |
 LL + use std::io::Result;
-LL | use foo::MyEnum::Result;
    |
 LL + use std::result::Result;
-LL | use foo::MyEnum::Result;
    |
 LL + use std::thread::Result;
-LL | use foo::MyEnum::Result;
    |
 
 error[E0573]: expected type, found variant `NoResult`

tests/ui/issues/issue-35976.unimported.stderr

@@ -10,7 +10,6 @@ LL |     arg.wait();
 help: another candidate was found in the following trait, perhaps add a `use` for it:
    |
 LL + use private::Future;
-LL | mod private {
    |
 
 error: aborting due to previous error

tests/ui/issues/issue-37534.stderr

@@ -7,7 +7,6 @@ LL | struct Foo<T: ?Hash> { }
 help: consider importing this trait instead
    |
 LL + use std::hash::Hash;
-LL | struct Foo<T: ?Hash> { }
    |
 
 warning: default bound relaxed for a type parameter, but this does nothing because the given bound is not a default; only `?Sized` is supported

tests/ui/issues/issue-39175.stderr

@@ -8,7 +8,6 @@ LL |     Command::new("echo").arg("hello").exec();
 help: the following trait is implemented but not in scope; perhaps add a `use` for it:
    |
 LL + use std::os::unix::process::CommandExt;
-LL | use std::process::Command;
    |
 
 error: aborting due to previous error