do not lint on macros, add more testcases

Jacherr · Jacherr · commit 9d0711421237 · 2024-08-09T19:56:53.000+01:00
diff --git a/clippy_lints/src/doc/doc_comment_double_space_linebreak.rs b/clippy_lints/src/doc/doc_comment_double_space_linebreak.rs
@@ -1,16 +1,13 @@
-use std::borrow::Cow;
-
 use clippy_utils::diagnostics::span_lint_and_then;
 use clippy_utils::source::snippet;
-use pulldown_cmark::CowStr;
 use rustc_errors::Applicability;
 use rustc_lint::LateContext;
 use rustc_span::Span;
 
 use super::DOC_COMMENT_DOUBLE_SPACE_LINEBREAK;
 
-pub fn check(cx: &LateContext<'_>, collected_breaks: Vec<(Span, (Span, CowStr<'_>), Cow<'_, str>)>) {
-    let replacements: Vec<_> = collect_doc_replacements(cx, &collected_breaks);
+pub fn check(cx: &LateContext<'_>, collected_breaks: &[Span]) {
+    let replacements: Vec<_> = collect_doc_replacements(cx, collected_breaks);
 
     if let Some((&(lo_span, _), &(hi_span, _))) = replacements.first().zip(replacements.last()) {
         span_lint_and_then(
@@ -29,16 +26,15 @@ pub fn check(cx: &LateContext<'_>, collected_breaks: Vec<(Span, (Span, CowStr<'_
     }
 }
 
-fn collect_doc_replacements(
-    cx: &LateContext<'_>,
-    attrs: &[(Span, (Span, CowStr<'_>), Cow<'_, str>)],
-) -> Vec<(Span, String)> {
-    attrs
+fn collect_doc_replacements(cx: &LateContext<'_>, spans: &[Span]) -> Vec<(Span, String)> {
+    spans
         .iter()
-        .map(|attr| {
-            let full = attr.0;
-            let new_comment = format!("\\\n/// ");
-            (full, new_comment)
+        .map(|span| {
+            let s = snippet(cx, *span, "..");
+            let after_newline = s.trim_start_matches(' ');
+
+            let new_comment = format!("\\{after_newline}");
+            (*span, new_comment)
         })
         .collect()
 }
diff --git a/clippy_lints/src/doc/mod.rs b/clippy_lints/src/doc/mod.rs
@@ -28,7 +28,6 @@ use rustc_resolve::rustdoc::{
 use rustc_session::impl_lint_pass;
 use rustc_span::edition::Edition;
 use rustc_span::{sym, Span};
-use std::borrow::Cow;
 use std::ops::Range;
 use url::Url;
 
@@ -691,8 +690,7 @@ fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize
     let mut paragraph_range = 0..0;
     let mut code_level = 0;
     let mut blockquote_level = 0;
-    let mut prev_text: Option<(Span, CowStr<'_>)> = None;
-    let mut collected_breaks: Vec<(Span, (Span, CowStr<'_>), Cow<'_, str>)> = Vec::new();
+    let mut collected_breaks: Vec<Span> = Vec::new();
 
     let mut containers = Vec::new();
 
@@ -808,19 +806,15 @@ fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize
                     );
                 }
 
-                if let Some(span) = fragments.span(cx, range.clone()) 
-                    && let Some(ref p) = prev_text
+                if let Some(span) = fragments.span(cx, range.clone())
+                    && !span.from_expansion()
                     && let snippet = snippet(cx, span, "..") 
-                    && !snippet.trim().starts_with("\\")
+                    && !snippet.trim().starts_with('\\')
                     && event == HardBreak {
-                    collected_breaks.push((span, p.clone(), snippet));
-                    prev_text = None;
+                    collected_breaks.push(span);
                 }
             },
             Text(text) => {
-                if let Some(span) = fragments.span(cx, range.clone()) {
-                    prev_text = Some((span, text.clone()));
-                }
                 paragraph_range.end = range.end;
                 let range_ = range.clone();
                 ticks_unbalanced |= text.contains('`')
@@ -869,7 +863,7 @@ fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize
         }
     }
 
-    doc_comment_double_space_linebreak::check(cx, collected_breaks);
+    doc_comment_double_space_linebreak::check(cx, &collected_breaks);
 
     headers
 }
diff --git a/tests/ui/doc/doc_comment_double_space_linebreak.fixed b/tests/ui/doc/doc_comment_double_space_linebreak.fixed
@@ -2,7 +2,7 @@
 #![rustfmt::skip]
 
 #![warn(clippy::doc_comment_double_space_linebreak)]
-#![allow(unused)]
+#![allow(unused, clippy::empty_docs)]
 
 //! Should warn on double space linebreaks\
 //! in file/module doc comment
@@ -58,4 +58,29 @@ macro_rules! macro_that_makes_function {
 
 macro_that_makes_function!();
 
+// dont lint when its alone on a line
+///  
+fn alone() {}
+
+/// | First column | Second column |  
+/// | ------------ | ------------- |  
+/// | Not a line   | break when    |  
+/// | after a line | in a table    |  
+fn table() {}
+
+/// ```text  
+/// It's also not a hard line break if  
+/// there's two spaces at the end of a  
+/// line in a block code.  
+/// ```  
+fn codeblock() {}
+
+/// It's also not a hard line break `if  
+/// there's` two spaces in the middle of inline code.  
+fn inline() {}
+
+/// It's also not a hard line break [when](  
+/// https://example.com) in a URL.  
+fn url() {}
+
 fn main() {}
diff --git a/tests/ui/doc/doc_comment_double_space_linebreak.rs b/tests/ui/doc/doc_comment_double_space_linebreak.rs
@@ -2,7 +2,7 @@
 #![rustfmt::skip]
 
 #![warn(clippy::doc_comment_double_space_linebreak)]
-#![allow(unused)]
+#![allow(unused, clippy::empty_docs)]
 
 //! Should warn on double space linebreaks  
 //! in file/module doc comment
@@ -58,4 +58,29 @@ macro_rules! macro_that_makes_function {
 
 macro_that_makes_function!();
 
+// dont lint when its alone on a line
+///  
+fn alone() {}
+
+/// | First column | Second column |  
+/// | ------------ | ------------- |  
+/// | Not a line   | break when    |  
+/// | after a line | in a table    |  
+fn table() {}
+
+/// ```text  
+/// It's also not a hard line break if  
+/// there's two spaces at the end of a  
+/// line in a block code.  
+/// ```  
+fn codeblock() {}
+
+/// It's also not a hard line break `if  
+/// there's` two spaces in the middle of inline code.  
+fn inline() {}
+
+/// It's also not a hard line break [when](  
+/// https://example.com) in a URL.  
+fn url() {}
+
 fn main() {}
diff --git a/tests/ui/doc/doc_comment_double_space_linebreak.stderr b/tests/ui/doc/doc_comment_double_space_linebreak.stderr
@@ -1,40 +1,53 @@
 error: doc comments should use a back-slash (\) instead of a double space to indicate a linebreak
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:7:1
+  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:7:43
    |
-LL | //! Should warn on double space linebreaks  
-   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: replace this double space with a back-slash: `//! Should warn on double space linebreaks\`
+LL |   //! Should warn on double space linebreaks  
+   |  ___________________________________________^
+LL | | //! in file/module doc comment
+   | |____^
    |
    = note: `-D clippy::doc-comment-double-space-linebreak` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::doc_comment_double_space_linebreak)]`
+help: replace this double space with a back-slash
+   |
+LL ~ //! Should warn on double space linebreaks\
+LL ~ //! in file/module doc comment
+   |
 
 error: doc comments should use a back-slash (\) instead of a double space to indicate a linebreak
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:35:1
+  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:35:51
    |
-LL | / /// Should warn when doc comment uses double space  
+LL |   /// Should warn when doc comment uses double space  
+   |  ___________________________________________________^
 LL | | /// as a line-break, even when there are multiple  
-   | |___________________________________________________^
+LL | | /// in a row
+   | |____^
    |
 help: replace this double space with a back-slash
    |
-LL + /// Should warn when doc comment uses double space\
-LL + /// as a line-break, even when there are multiple\
+LL ~ /// Should warn when doc comment uses double space\
+LL ~ /// as a line-break, even when there are multiple\
+LL ~ /// in a row
    |
 
 error: doc comments should use a back-slash (\) instead of a double space to indicate a linebreak
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:44:1
+  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:44:12
    |
-LL | / /// 🌹 are 🟥  
+LL |   /// 🌹 are 🟥  
+   |  ______________^
 LL | | /// 🌷 are 🟦  
 LL | | /// 📎 is 😎  
 LL | | /// and so are 🫵  
-   | |___________________^
+LL | | /// (hopefully no formatting weirdness linting this)
+   | |____^
    |
 help: replace this double space with a back-slash
    |
 LL ~ /// 🌹 are 🟥\
 LL ~ /// 🌷 are 🟦\
 LL ~ /// 📎 is 😎\
 LL ~ /// and so are 🫵\
+LL ~ /// (hopefully no formatting weirdness linting this)
    |
 
 error: aborting due to 3 previous errors
