-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make it trim the contents
- Loading branch information
Showing
7 changed files
with
249 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
use clippy_utils::{diagnostics::span_lint_and_sugg, source::snippet_opt}; | ||
use rustc_errors::Applicability; | ||
use rustc_hir::Item; | ||
use rustc_lint::{LateContext, LateLintPass, LintContext}; | ||
use rustc_session::{declare_lint_pass, declare_tool_lint}; | ||
use rustc_span::{Span, SyntaxContext}; | ||
|
||
declare_clippy_lint! { | ||
/// ### What it does | ||
/// Checks for outer doc comments written with 4 forward slashes (`////`). | ||
/// | ||
/// ### Why is this bad? | ||
/// This is (probably) a typo, and results in it not being a doc comment; just a regular | ||
/// comment. | ||
/// | ||
/// ### Example | ||
/// ```rust | ||
/// //// My amazing data structure | ||
/// pub struct Foo { | ||
/// // ... | ||
/// } | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```rust | ||
/// /// My amazing data structure | ||
/// pub struct Foo { | ||
/// // ... | ||
/// } | ||
/// ``` | ||
#[clippy::version = "1.72.0"] | ||
pub FOUR_FORWARD_SLASHES, | ||
suspicious, | ||
"comments with 4 forward slashes (`////`) likely intended to be doc comments (`///`)" | ||
} | ||
declare_lint_pass!(FourForwardSlashes => [FOUR_FORWARD_SLASHES]); | ||
|
||
impl<'tcx> LateLintPass<'tcx> for FourForwardSlashes { | ||
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'tcx>) { | ||
if item.span.from_expansion() { | ||
return; | ||
} | ||
let src = cx.sess().source_map(); | ||
let item_and_attrs_span = cx | ||
.tcx | ||
.hir() | ||
.attrs(item.hir_id()) | ||
.iter() | ||
.fold(item.span.shrink_to_lo(), |span, attr| span.to(attr.span)); | ||
let (Some(file), _, _, end_line, _) = src.span_to_location_info(item_and_attrs_span) else { | ||
return; | ||
}; | ||
for line in (0..end_line.saturating_sub(1)).rev() { | ||
let Some(contents) = file.get_line(line) else { | ||
continue; | ||
}; | ||
let contents = contents.trim(); | ||
if contents.is_empty() { | ||
break; | ||
} | ||
if contents.starts_with("////") { | ||
let bounds = file.line_bounds(line); | ||
let span = Span::new(bounds.start, bounds.end, SyntaxContext::root(), None); | ||
|
||
if snippet_opt(cx, span).is_some_and(|s| s.trim().starts_with("////")) { | ||
span_lint_and_sugg( | ||
cx, | ||
FOUR_FORWARD_SLASHES, | ||
span, | ||
"comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't", | ||
"make this a doc comment by removing one `/`", | ||
// It's a little unfortunate but the span includes the `\n` yet the contents | ||
// do not, so we must add it back. If some codebase uses `\r\n` instead they | ||
// will need normalization but it should be fine | ||
contents.replacen("////", "///", 1) + "\n", | ||
Applicability::MachineApplicable, | ||
); | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
//// first line borked doc comment. doesn't combust! | ||
//@run-rustfix | ||
//@aux-build:proc_macros.rs:proc-macro | ||
#![feature(custom_inner_attributes)] | ||
#![allow(unused)] | ||
#![warn(clippy::four_forward_slashes)] | ||
#![no_main] | ||
#![rustfmt::skip] | ||
|
||
#[macro_use] | ||
extern crate proc_macros; | ||
|
||
/// whoops | ||
fn a() {} | ||
|
||
/// whoops | ||
#[allow(dead_code)] | ||
fn b() {} | ||
|
||
/// whoops | ||
/// two borked comments! | ||
#[track_caller] | ||
fn c() {} | ||
|
||
fn d() {} | ||
|
||
#[test] | ||
/// between attributes | ||
#[allow(dead_code)] | ||
fn g() {} | ||
|
||
/// not very start of contents | ||
fn h() {} | ||
|
||
external! { | ||
//// don't lint me bozo | ||
fn e() {} | ||
} | ||
|
||
with_span! { | ||
span | ||
//// don't lint me bozo | ||
fn f() {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
//// first line borked doc comment. doesn't combust! | ||
//@run-rustfix | ||
//@aux-build:proc_macros.rs:proc-macro | ||
#![feature(custom_inner_attributes)] | ||
#![allow(unused)] | ||
#![warn(clippy::four_forward_slashes)] | ||
#![no_main] | ||
#![rustfmt::skip] | ||
|
||
#[macro_use] | ||
extern crate proc_macros; | ||
|
||
//// whoops | ||
fn a() {} | ||
|
||
//// whoops | ||
#[allow(dead_code)] | ||
fn b() {} | ||
|
||
//// whoops | ||
//// two borked comments! | ||
#[track_caller] | ||
fn c() {} | ||
|
||
fn d() {} | ||
|
||
#[test] | ||
//// between attributes | ||
#[allow(dead_code)] | ||
fn g() {} | ||
|
||
//// not very start of contents | ||
fn h() {} | ||
|
||
external! { | ||
//// don't lint me bozo | ||
fn e() {} | ||
} | ||
|
||
with_span! { | ||
span | ||
//// don't lint me bozo | ||
fn f() {} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:13:1 | ||
| | ||
LL | / //// whoops | ||
LL | | fn a() {} | ||
| |_ | ||
| | ||
= note: `-D clippy::four-forward-slashes` implied by `-D warnings` | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// whoops | ||
| | ||
|
||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:16:1 | ||
| | ||
LL | / //// whoops | ||
LL | | #[allow(dead_code)] | ||
| |_ | ||
| | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// whoops | ||
| | ||
|
||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:21:1 | ||
| | ||
LL | / //// two borked comments! | ||
LL | | #[track_caller] | ||
| |_ | ||
| | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// two borked comments! | ||
| | ||
|
||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:20:1 | ||
| | ||
LL | / //// whoops | ||
LL | | //// two borked comments! | ||
| |_ | ||
| | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// whoops | ||
| | ||
|
||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:28:1 | ||
| | ||
LL | / //// between attributes | ||
LL | | #[allow(dead_code)] | ||
| |_ | ||
| | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// between attributes | ||
| | ||
|
||
error: comment with 4 forward slashes (`////`). This looks like a doc comment, but it isn't | ||
--> $DIR/four_forward_slashes.rs:32:1 | ||
| | ||
LL | / //// not very start of contents | ||
LL | | fn h() {} | ||
| |_ | ||
| | ||
help: make this a doc comment by removing one `/` | ||
| | ||
LL + /// not very start of contents | ||
| | ||
|
||
error: aborting due to 6 previous errors | ||
|