Auto merge of #11569 - Alexendoo:needless-raw-string-descr, r=llogiq

bors · bors · commit 4494b6947f16 · 2023-09-26T21:16:33.000Z
Describe the type of string in raw_strings lints

changelog: none
diff --git a/clippy_lints/src/raw_strings.rs b/clippy_lints/src/raw_strings.rs
@@ -75,6 +75,7 @@ impl EarlyLintPass for RawStrings {
             if !snippet(cx, expr.span, prefix).trim().starts_with(prefix) {
                 return;
             }
+            let descr = lit.kind.descr();
 
             if !str.contains(['\\', '"']) {
                 span_lint_and_then(
@@ -89,20 +90,17 @@ impl EarlyLintPass for RawStrings {
                         let r_pos = expr.span.lo() + BytePos::from_usize(prefix.len() - 1);
                         let start = start.with_lo(r_pos);
 
-                        if end.is_empty() {
-                            diag.span_suggestion(
-                                start,
-                                "use a string literal instead",
-                                format!("\"{str}\""),
-                                Applicability::MachineApplicable,
-                            );
-                        } else {
-                            diag.multipart_suggestion(
-                                "try",
-                                vec![(start, String::new()), (end, String::new())],
-                                Applicability::MachineApplicable,
-                            );
+                        let mut remove = vec![(start, String::new())];
+                        // avoid debug ICE from empty suggestions
+                        if !end.is_empty() {
+                            remove.push((end, String::new()));
                         }
+
+                        diag.multipart_suggestion_verbose(
+                            format!("use a plain {descr} literal instead"),
+                            remove,
+                            Applicability::MachineApplicable,
+                        );
                     },
                 );
                 if !matches!(cx.get_lint_level(NEEDLESS_RAW_STRINGS), rustc_lint::Allow) {
@@ -149,9 +147,9 @@ impl EarlyLintPass for RawStrings {
                         let (start, end) = hash_spans(expr.span, prefix, req, max);
 
                         let message = match max - req {
-                            _ if req == 0 => "remove all the hashes around the literal".to_string(),
-                            1 => "remove one hash from both sides of the literal".to_string(),
-                            n => format!("remove {n} hashes from both sides of the literal"),
+                            _ if req == 0 => format!("remove all the hashes around the {descr} literal"),
+                            1 => format!("remove one hash from both sides of the {descr} literal"),
+                            n => format!("remove {n} hashes from both sides of the {descr} literal"),
                         };
 
                         diag.multipart_suggestion(
diff --git a/tests/ui/needless_raw_string.fixed b/tests/ui/needless_raw_string.fixed
@@ -18,4 +18,8 @@ fn main() {
         multiline
         string
     ";
+
+    "no hashes";
+    b"no hashes";
+    c"no hashes";
 }
diff --git a/tests/ui/needless_raw_string.rs b/tests/ui/needless_raw_string.rs
@@ -18,4 +18,8 @@ fn main() {
         multiline
         string
     "#;
+
+    r"no hashes";
+    br"no hashes";
+    cr"no hashes";
 }
diff --git a/tests/ui/needless_raw_string.stderr b/tests/ui/needless_raw_string.stderr
@@ -6,7 +6,7 @@ LL |     r#"aaa"#;
    |
    = note: `-D clippy::needless-raw-strings` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::needless_raw_strings)]`
-help: try
+help: use a plain string literal instead
    |
 LL -     r#"aaa"#;
 LL +     "aaa";
@@ -18,7 +18,7 @@ error: unnecessary raw string literal
 LL |     br#"aaa"#;
    |     ^^^^^^^^^
    |
-help: try
+help: use a plain byte string literal instead
    |
 LL -     br#"aaa"#;
 LL +     b"aaa";
@@ -30,7 +30,7 @@ error: unnecessary raw string literal
 LL |     cr#"aaa"#;
    |     ^^^^^^^^^
    |
-help: try
+help: use a plain C string literal instead
    |
 LL -     cr#"aaa"#;
 LL +     c"aaa";
@@ -46,7 +46,7 @@ LL | |         string
 LL | |     "#;
    | |______^
    |
-help: try
+help: use a plain string literal instead
    |
 LL ~     "
 LL |         a
@@ -55,5 +55,41 @@ LL |         string
 LL ~     ";
    |
 
-error: aborting due to 4 previous errors
+error: unnecessary raw string literal
+  --> $DIR/needless_raw_string.rs:22:5
+   |
+LL |     r"no hashes";
+   |     ^^^^^^^^^^^^
+   |
+help: use a plain string literal instead
+   |
+LL -     r"no hashes";
+LL +     "no hashes";
+   |
+
+error: unnecessary raw string literal
+  --> $DIR/needless_raw_string.rs:23:5
+   |
+LL |     br"no hashes";
+   |     ^^^^^^^^^^^^^
+   |
+help: use a plain byte string literal instead
+   |
+LL -     br"no hashes";
+LL +     b"no hashes";
+   |
+
+error: unnecessary raw string literal
+  --> $DIR/needless_raw_string.rs:24:5
+   |
+LL |     cr"no hashes";
+   |     ^^^^^^^^^^^^^
+   |
+help: use a plain C string literal instead
+   |
+LL -     cr"no hashes";
+LL +     c"no hashes";
+   |
+
+error: aborting due to 7 previous errors
 
diff --git a/tests/ui/needless_raw_string_hashes.stderr b/tests/ui/needless_raw_string_hashes.stderr
@@ -6,7 +6,7 @@ LL |     r#"\aaa"#;
    |
    = note: `-D clippy::needless-raw-string-hashes` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::needless_raw_string_hashes)]`
-help: remove all the hashes around the literal
+help: remove all the hashes around the string literal
    |
 LL -     r#"\aaa"#;
 LL +     r"\aaa";
@@ -18,7 +18,7 @@ error: unnecessary hashes around raw string literal
 LL |     r##"Hello "world"!"##;
    |     ^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove one hash from both sides of the literal
+help: remove one hash from both sides of the string literal
    |
 LL -     r##"Hello "world"!"##;
 LL +     r#"Hello "world"!"#;
@@ -30,7 +30,7 @@ error: unnecessary hashes around raw string literal
 LL |     r######" "### "## "# "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 2 hashes from both sides of the literal
+help: remove 2 hashes from both sides of the string literal
    |
 LL -     r######" "### "## "# "######;
 LL +     r####" "### "## "# "####;
@@ -42,7 +42,7 @@ error: unnecessary hashes around raw string literal
 LL |     r######" "aa" "# "## "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 3 hashes from both sides of the literal
+help: remove 3 hashes from both sides of the string literal
    |
 LL -     r######" "aa" "# "## "######;
 LL +     r###" "aa" "# "## "###;
@@ -54,7 +54,7 @@ error: unnecessary hashes around raw string literal
 LL |     br#"\aaa"#;
    |     ^^^^^^^^^^
    |
-help: remove all the hashes around the literal
+help: remove all the hashes around the byte string literal
    |
 LL -     br#"\aaa"#;
 LL +     br"\aaa";
@@ -66,7 +66,7 @@ error: unnecessary hashes around raw string literal
 LL |     br##"Hello "world"!"##;
    |     ^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove one hash from both sides of the literal
+help: remove one hash from both sides of the byte string literal
    |
 LL -     br##"Hello "world"!"##;
 LL +     br#"Hello "world"!"#;
@@ -78,7 +78,7 @@ error: unnecessary hashes around raw string literal
 LL |     br######" "### "## "# "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 2 hashes from both sides of the literal
+help: remove 2 hashes from both sides of the byte string literal
    |
 LL -     br######" "### "## "# "######;
 LL +     br####" "### "## "# "####;
@@ -90,7 +90,7 @@ error: unnecessary hashes around raw string literal
 LL |     br######" "aa" "# "## "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 3 hashes from both sides of the literal
+help: remove 3 hashes from both sides of the byte string literal
    |
 LL -     br######" "aa" "# "## "######;
 LL +     br###" "aa" "# "## "###;
@@ -102,7 +102,7 @@ error: unnecessary hashes around raw string literal
 LL |     cr#"\aaa"#;
    |     ^^^^^^^^^^
    |
-help: remove all the hashes around the literal
+help: remove all the hashes around the C string literal
    |
 LL -     cr#"\aaa"#;
 LL +     cr"\aaa";
@@ -114,7 +114,7 @@ error: unnecessary hashes around raw string literal
 LL |     cr##"Hello "world"!"##;
    |     ^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove one hash from both sides of the literal
+help: remove one hash from both sides of the C string literal
    |
 LL -     cr##"Hello "world"!"##;
 LL +     cr#"Hello "world"!"#;
@@ -126,7 +126,7 @@ error: unnecessary hashes around raw string literal
 LL |     cr######" "### "## "# "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 2 hashes from both sides of the literal
+help: remove 2 hashes from both sides of the C string literal
    |
 LL -     cr######" "### "## "# "######;
 LL +     cr####" "### "## "# "####;
@@ -138,7 +138,7 @@ error: unnecessary hashes around raw string literal
 LL |     cr######" "aa" "# "## "######;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-help: remove 3 hashes from both sides of the literal
+help: remove 3 hashes from both sides of the C string literal
    |
 LL -     cr######" "aa" "# "## "######;
 LL +     cr###" "aa" "# "## "###;
@@ -154,7 +154,7 @@ LL | |         string
 LL | |     "#;
    | |______^
    |
-help: remove all the hashes around the literal
+help: remove all the hashes around the string literal
    |
 LL ~     r"
 LL |         \a
@@ -169,7 +169,7 @@ error: unnecessary hashes around raw string literal
 LL |     r###"rust"###;
    |     ^^^^^^^^^^^^^
    |
-help: remove all the hashes around the literal
+help: remove all the hashes around the string literal
    |
 LL -     r###"rust"###;
 LL +     r"rust";
@@ -181,7 +181,7 @@ error: unnecessary hashes around raw string literal
 LL |     r#"hello world"#;
    |     ^^^^^^^^^^^^^^^^
    |
-help: remove all the hashes around the literal
+help: remove all the hashes around the string literal
    |
 LL -     r#"hello world"#;
 LL +     r"hello world";
diff --git a/tests/ui/write_literal_2.rs b/tests/ui/write_literal_2.rs
@@ -1,6 +1,6 @@
 //@no-rustfix: overlapping suggestions
 #![allow(unused_must_use)]
-#![warn(clippy::needless_raw_strings, clippy::write_literal)]
+#![warn(clippy::write_literal)]
 
 use std::io::Write;
 
@@ -11,9 +11,7 @@ fn main() {
     //~^ ERROR: literal with an empty format string
     //~| NOTE: `-D clippy::write-literal` implied by `-D warnings`
     writeln!(v, r"{}", r"{hello}");
-    //~^ ERROR: unnecessary raw string literal
-    //~| NOTE: `-D clippy::needless-raw-strings` implied by `-D warnings`
-    //~| ERROR: literal with an empty format string
+    //~^ ERROR: literal with an empty format string
     writeln!(v, "{}", '\'');
     //~^ ERROR: literal with an empty format string
     writeln!(v, "{}", '"');
@@ -26,8 +24,8 @@ fn main() {
         v,
         "some {}",
         "hello \
-        //~^ ERROR: literal with an empty format string
-        world!"
+        world!",
+        //~^^ ERROR: literal with an empty format string
     );
     writeln!(
         v,
diff --git a/tests/ui/write_literal_2.stderr b/tests/ui/write_literal_2.stderr

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,8 @@ fn main() {`
`18`	`18`	`multiline`
`19`	`19`	`string`
`20`	`20`	`";`
	`21`	`+`
	`22`	`+ "no hashes";`
	`23`	`+ b"no hashes";`
	`24`	`+ c"no hashes";`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ LL \| r#"\aaa"#;`
`6`	`6`	`\|`
`7`	`7`	= note: `-D clippy::needless-raw-string-hashes` implied by `-D warnings`
`8`	`8`	= help: to override `-D warnings` add `#[allow(clippy::needless_raw_string_hashes)]`
`9`		`-help: remove all the hashes around the literal`
	`9`	`+help: remove all the hashes around the string literal`
`10`	`10`	`\|`
`11`	`11`	`LL - r#"\aaa"#;`
`12`	`12`	`LL + r"\aaa";`
`@@ -18,7 +18,7 @@ error: unnecessary hashes around raw string literal`
`18`	`18`	`LL \| r##"Hello "world"!"##;`
`19`	`19`	`\| ^^^^^^^^^^^^^^^^^^^^^`
`20`	`20`	`\|`
`21`		`-help: remove one hash from both sides of the literal`
	`21`	`+help: remove one hash from both sides of the string literal`
`22`	`22`	`\|`
`23`	`23`	`LL - r##"Hello "world"!"##;`
`24`	`24`	`LL + r#"Hello "world"!"#;`
`@@ -30,7 +30,7 @@ error: unnecessary hashes around raw string literal`
`30`	`30`	`LL \| r######" "### "## "# "######;`
`31`	`31`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`32`	`32`	`\|`
`33`		`-help: remove 2 hashes from both sides of the literal`
	`33`	`+help: remove 2 hashes from both sides of the string literal`
`34`	`34`	`\|`
`35`	`35`	`LL - r######" "### "## "# "######;`
`36`	`36`	`LL + r####" "### "## "# "####;`
`@@ -42,7 +42,7 @@ error: unnecessary hashes around raw string literal`
`42`	`42`	`LL \| r######" "aa" "# "## "######;`
`43`	`43`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`44`	`44`	`\|`
`45`		`-help: remove 3 hashes from both sides of the literal`
	`45`	`+help: remove 3 hashes from both sides of the string literal`
`46`	`46`	`\|`
`47`	`47`	`LL - r######" "aa" "# "## "######;`
`48`	`48`	`LL + r###" "aa" "# "## "###;`
`@@ -54,7 +54,7 @@ error: unnecessary hashes around raw string literal`
`54`	`54`	`LL \| br#"\aaa"#;`
`55`	`55`	`\| ^^^^^^^^^^`
`56`	`56`	`\|`
`57`		`-help: remove all the hashes around the literal`
	`57`	`+help: remove all the hashes around the byte string literal`
`58`	`58`	`\|`
`59`	`59`	`LL - br#"\aaa"#;`
`60`	`60`	`LL + br"\aaa";`
`@@ -66,7 +66,7 @@ error: unnecessary hashes around raw string literal`
`66`	`66`	`LL \| br##"Hello "world"!"##;`
`67`	`67`	`\| ^^^^^^^^^^^^^^^^^^^^^^`
`68`	`68`	`\|`
`69`		`-help: remove one hash from both sides of the literal`
	`69`	`+help: remove one hash from both sides of the byte string literal`
`70`	`70`	`\|`
`71`	`71`	`LL - br##"Hello "world"!"##;`
`72`	`72`	`LL + br#"Hello "world"!"#;`
`@@ -78,7 +78,7 @@ error: unnecessary hashes around raw string literal`
`78`	`78`	`LL \| br######" "### "## "# "######;`
`79`	`79`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`80`	`80`	`\|`
`81`		`-help: remove 2 hashes from both sides of the literal`
	`81`	`+help: remove 2 hashes from both sides of the byte string literal`
`82`	`82`	`\|`
`83`	`83`	`LL - br######" "### "## "# "######;`
`84`	`84`	`LL + br####" "### "## "# "####;`
`@@ -90,7 +90,7 @@ error: unnecessary hashes around raw string literal`
`90`	`90`	`LL \| br######" "aa" "# "## "######;`
`91`	`91`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`92`	`92`	`\|`
`93`		`-help: remove 3 hashes from both sides of the literal`
	`93`	`+help: remove 3 hashes from both sides of the byte string literal`
`94`	`94`	`\|`
`95`	`95`	`LL - br######" "aa" "# "## "######;`
`96`	`96`	`LL + br###" "aa" "# "## "###;`
`@@ -102,7 +102,7 @@ error: unnecessary hashes around raw string literal`
`102`	`102`	`LL \| cr#"\aaa"#;`
`103`	`103`	`\| ^^^^^^^^^^`
`104`	`104`	`\|`
`105`		`-help: remove all the hashes around the literal`
	`105`	`+help: remove all the hashes around the C string literal`
`106`	`106`	`\|`
`107`	`107`	`LL - cr#"\aaa"#;`
`108`	`108`	`LL + cr"\aaa";`
`@@ -114,7 +114,7 @@ error: unnecessary hashes around raw string literal`
`114`	`114`	`LL \| cr##"Hello "world"!"##;`
`115`	`115`	`\| ^^^^^^^^^^^^^^^^^^^^^^`
`116`	`116`	`\|`
`117`		`-help: remove one hash from both sides of the literal`
	`117`	`+help: remove one hash from both sides of the C string literal`
`118`	`118`	`\|`
`119`	`119`	`LL - cr##"Hello "world"!"##;`
`120`	`120`	`LL + cr#"Hello "world"!"#;`
`@@ -126,7 +126,7 @@ error: unnecessary hashes around raw string literal`
`126`	`126`	`LL \| cr######" "### "## "# "######;`
`127`	`127`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`128`	`128`	`\|`
`129`		`-help: remove 2 hashes from both sides of the literal`
	`129`	`+help: remove 2 hashes from both sides of the C string literal`
`130`	`130`	`\|`
`131`	`131`	`LL - cr######" "### "## "# "######;`
`132`	`132`	`LL + cr####" "### "## "# "####;`
`@@ -138,7 +138,7 @@ error: unnecessary hashes around raw string literal`
`138`	`138`	`LL \| cr######" "aa" "# "## "######;`
`139`	`139`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`140`	`140`	`\|`
`141`		`-help: remove 3 hashes from both sides of the literal`
	`141`	`+help: remove 3 hashes from both sides of the C string literal`
`142`	`142`	`\|`
`143`	`143`	`LL - cr######" "aa" "# "## "######;`
`144`	`144`	`LL + cr###" "aa" "# "## "###;`
`@@ -154,7 +154,7 @@ LL \| \| string`
`154`	`154`	`LL \| \| "#;`
`155`	`155`	`\| \|______^`
`156`	`156`	`\|`
`157`		`-help: remove all the hashes around the literal`
	`157`	`+help: remove all the hashes around the string literal`
`158`	`158`	`\|`
`159`	`159`	`LL ~ r"`
`160`	`160`	`LL \| \a`
`@@ -169,7 +169,7 @@ error: unnecessary hashes around raw string literal`
`169`	`169`	`LL \| r###"rust"###;`
`170`	`170`	`\| ^^^^^^^^^^^^^`
`171`	`171`	`\|`
`172`		`-help: remove all the hashes around the literal`
	`172`	`+help: remove all the hashes around the string literal`
`173`	`173`	`\|`
`174`	`174`	`LL - r###"rust"###;`
`175`	`175`	`LL + r"rust";`
`@@ -181,7 +181,7 @@ error: unnecessary hashes around raw string literal`
`181`	`181`	`LL \| r#"hello world"#;`
`182`	`182`	`\| ^^^^^^^^^^^^^^^^`
`183`	`183`	`\|`
`184`		`-help: remove all the hashes around the literal`
	`184`	`+help: remove all the hashes around the string literal`
`185`	`185`	`\|`
`186`	`186`	`LL - r#"hello world"#;`
`187`	`187`	`LL + r"hello world";`