summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs')
-rw-r--r--src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs b/src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs
new file mode 100644
index 000000000..cb07f57e8
--- /dev/null
+++ b/src/tools/clippy/clippy_lints/src/doc_link_with_quotes.rs
@@ -0,0 +1,60 @@
+use clippy_utils::diagnostics::span_lint;
+use itertools::Itertools;
+use rustc_ast::{AttrKind, Attribute};
+use rustc_lint::{EarlyContext, EarlyLintPass};
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+
+declare_clippy_lint! {
+ /// ### What it does
+ /// Detects the syntax `['foo']` in documentation comments (notice quotes instead of backticks)
+ /// outside of code blocks
+ /// ### Why is this bad?
+ /// It is likely a typo when defining an intra-doc link
+ ///
+ /// ### Example
+ /// ```rust
+ /// /// See also: ['foo']
+ /// fn bar() {}
+ /// ```
+ /// Use instead:
+ /// ```rust
+ /// /// See also: [`foo`]
+ /// fn bar() {}
+ /// ```
+ #[clippy::version = "1.60.0"]
+ pub DOC_LINK_WITH_QUOTES,
+ pedantic,
+ "possible typo for an intra-doc link"
+}
+declare_lint_pass!(DocLinkWithQuotes => [DOC_LINK_WITH_QUOTES]);
+
+impl EarlyLintPass for DocLinkWithQuotes {
+ fn check_attribute(&mut self, ctx: &EarlyContext<'_>, attr: &Attribute) {
+ if let AttrKind::DocComment(_, symbol) = attr.kind {
+ if contains_quote_link(symbol.as_str()) {
+ span_lint(
+ ctx,
+ DOC_LINK_WITH_QUOTES,
+ attr.span,
+ "possible intra-doc link using quotes instead of backticks",
+ );
+ }
+ }
+ }
+}
+
+fn contains_quote_link(s: &str) -> bool {
+ let mut in_backticks = false;
+ let mut found_opening = false;
+
+ for c in s.chars().tuple_windows::<(char, char)>() {
+ match c {
+ ('`', _) => in_backticks = !in_backticks,
+ ('[', '\'') if !in_backticks => found_opening = true,
+ ('\'', ']') if !in_backticks && found_opening => return true,
+ _ => {},
+ }
+ }
+
+ false
+}