forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of rust-lang#77856 - GuillaumeGomez:automatic-links-lint…
…, r=jyn514 Add automatic_links lint Fixes rust-lang#77501. r? @jyn514
- Loading branch information
Showing
14 changed files
with
373 additions
and
4 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
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
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
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,127 @@ | ||
| use super::{span_of_attrs, Pass}; | ||
| use crate::clean::*; | ||
| use crate::core::DocContext; | ||
| use crate::fold::DocFolder; | ||
| use crate::html::markdown::opts; | ||
| use core::ops::Range; | ||
| use pulldown_cmark::{Event, LinkType, Parser, Tag}; | ||
| use regex::Regex; | ||
| use rustc_errors::Applicability; | ||
| use rustc_feature::UnstableFeatures; | ||
| use rustc_session::lint; | ||
|
|
||
| pub const CHECK_AUTOMATIC_LINKS: Pass = Pass { | ||
| name: "check-automatic-links", | ||
| run: check_automatic_links, | ||
| description: "detects URLS that could be written using angle brackets", | ||
| }; | ||
|
|
||
| const URL_REGEX: &str = concat!( | ||
| r"https?://", // url scheme | ||
| r"([-a-zA-Z0-9@:%._\+~#=]{2,256}\.)+", // one or more subdomains | ||
| r"[a-zA-Z]{2,4}", // root domain | ||
| r"\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)" // optional query or url fragments | ||
| ); | ||
|
|
||
| struct AutomaticLinksLinter<'a, 'tcx> { | ||
| cx: &'a DocContext<'tcx>, | ||
| regex: Regex, | ||
| } | ||
|
|
||
| impl<'a, 'tcx> AutomaticLinksLinter<'a, 'tcx> { | ||
| fn new(cx: &'a DocContext<'tcx>) -> Self { | ||
| AutomaticLinksLinter { cx, regex: Regex::new(URL_REGEX).expect("failed to build regex") } | ||
| } | ||
|
|
||
| fn find_raw_urls( | ||
| &self, | ||
| text: &str, | ||
| range: Range<usize>, | ||
| f: &impl Fn(&DocContext<'_>, &str, &str, Range<usize>), | ||
| ) { | ||
| // For now, we only check "full" URLs (meaning, starting with "http://" or "https://"). | ||
| for match_ in self.regex.find_iter(&text) { | ||
| let url = match_.as_str(); | ||
| let url_range = match_.range(); | ||
| f( | ||
| self.cx, | ||
| "this URL is not a hyperlink", | ||
| url, | ||
| Range { start: range.start + url_range.start, end: range.start + url_range.end }, | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| pub fn check_automatic_links(krate: Crate, cx: &DocContext<'_>) -> Crate { | ||
| if !UnstableFeatures::from_environment().is_nightly_build() { | ||
| krate | ||
| } else { | ||
| let mut coll = AutomaticLinksLinter::new(cx); | ||
|
|
||
| coll.fold_crate(krate) | ||
| } | ||
| } | ||
|
|
||
| impl<'a, 'tcx> DocFolder for AutomaticLinksLinter<'a, 'tcx> { | ||
| fn fold_item(&mut self, item: Item) -> Option<Item> { | ||
| let hir_id = match self.cx.as_local_hir_id(item.def_id) { | ||
| Some(hir_id) => hir_id, | ||
| None => { | ||
| // If non-local, no need to check anything. | ||
| return self.fold_item_recur(item); | ||
| } | ||
| }; | ||
| let dox = item.attrs.collapsed_doc_value().unwrap_or_default(); | ||
| if !dox.is_empty() { | ||
| let report_diag = |cx: &DocContext<'_>, msg: &str, url: &str, range: Range<usize>| { | ||
| let sp = super::source_span_for_markdown_range(cx, &dox, &range, &item.attrs) | ||
| .or_else(|| span_of_attrs(&item.attrs)) | ||
| .unwrap_or(item.source.span()); | ||
| cx.tcx.struct_span_lint_hir(lint::builtin::AUTOMATIC_LINKS, hir_id, sp, |lint| { | ||
| lint.build(msg) | ||
| .span_suggestion( | ||
| sp, | ||
| "use an automatic link instead", | ||
| format!("<{}>", url), | ||
| Applicability::MachineApplicable, | ||
| ) | ||
| .emit() | ||
| }); | ||
| }; | ||
|
|
||
| let p = Parser::new_ext(&dox, opts()).into_offset_iter(); | ||
|
|
||
| let mut title = String::new(); | ||
| let mut in_link = false; | ||
| let mut ignore = false; | ||
|
|
||
| for (event, range) in p { | ||
| match event { | ||
| Event::Start(Tag::Link(kind, _, _)) => { | ||
| in_link = true; | ||
| ignore = matches!(kind, LinkType::Autolink | LinkType::Email); | ||
| } | ||
| Event::End(Tag::Link(_, url, _)) => { | ||
| in_link = false; | ||
| // NOTE: links cannot be nested, so we don't need to check `kind` | ||
| if url.as_ref() == title && !ignore { | ||
| report_diag(self.cx, "unneeded long form for URL", &url, range); | ||
| } | ||
| title.clear(); | ||
| ignore = false; | ||
| } | ||
| Event::Text(s) if in_link => { | ||
| if !ignore { | ||
| title.push_str(&s); | ||
| } | ||
| } | ||
| Event::Text(s) => self.find_raw_urls(&s, range, &report_diag), | ||
| _ => {} | ||
| } | ||
| } | ||
| } | ||
|
|
||
| self.fold_item_recur(item) | ||
| } | ||
| } |
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,60 @@ | ||
| #![deny(automatic_links)] | ||
|
|
||
| /// [http://a.com](http://a.com) | ||
| //~^ ERROR unneeded long form for URL | ||
| /// [http://b.com] | ||
| //~^ ERROR unneeded long form for URL | ||
| /// | ||
| /// [http://b.com]: http://b.com | ||
| /// | ||
| /// [http://c.com][http://c.com] | ||
| pub fn a() {} | ||
|
|
||
| /// https://somewhere.com | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com/a | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://www.somewhere.com | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://www.somewhere.com/a | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://subdomain.example.com | ||
| //~^ ERROR not a hyperlink | ||
| /// https://somewhere.com? | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com/a? | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com?hello=12 | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com/a?hello=12 | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://example.com?hello=12#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://example.com/a?hello=12#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://example.com#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://example.com/a#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com?hello=12&bye=11 | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com/a?hello=12&bye=11 | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// https://somewhere.com?hello=12&bye=11#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| /// hey! https://somewhere.com/a?hello=12&bye=11#xyz | ||
| //~^ ERROR this URL is not a hyperlink | ||
| pub fn c() {} | ||
|
|
||
| /// <https://somewhere.com> | ||
| /// [a](http://a.com) | ||
| /// [b] | ||
| /// | ||
| /// [b]: http://b.com | ||
| pub fn everything_is_fine_here() {} | ||
|
|
||
| #[allow(automatic_links)] | ||
| pub mod foo { | ||
| /// https://somewhere.com/a?hello=12&bye=11#xyz | ||
| pub fn bar() {} | ||
| } |
Oops, something went wrong.