Merge pull request #1838 from rust-lang-nursery/fix-doc

Don't lint autolinks in `doc_markdown`

Author: oli-obk

Cargo.lock

@@ -28,6 +28,7 @@ serde_derive = "1.0"
 toml = "0.4"
 unicode-normalization = "0.1"
 pulldown-cmark = "0.0.15"
+url = "1.5.0"
 
 [features]
 debugging = []

clippy_lints/Cargo.toml

@@ -5,6 +5,7 @@ use syntax::ast;
 use syntax::codemap::{BytePos, Span};
 use syntax_pos::Pos;
 use utils::span_lint;
+use url::Url;
 
 /// **What it does:** Checks for the presence of `_`, `::` or camel-case words
 /// outside ticks in documentation.
@@ -195,16 +196,26 @@ fn check_doc<'a, Events: Iterator<Item = (usize, pulldown_cmark::Event<'a>)>>(
     use pulldown_cmark::Tag::*;
 
     let mut in_code = false;
+    let mut in_link = None;
 
     for (offset, event) in docs {
         match event {
             Start(CodeBlock(_)) | Start(Code) => in_code = true,
             End(CodeBlock(_)) | End(Code) => in_code = false,
-            Start(_tag) | End(_tag) => (),         // We don't care about other tags
+            Start(Link(link, _)) => in_link = Some(link),
+            End(Link(_, _)) => in_link = None,
+            Start(_tag) | End(_tag) => (), // We don't care about other tags
             Html(_html) | InlineHtml(_html) => (), // HTML is weird, just ignore it
             SoftBreak => (),
             HardBreak => (),
             FootnoteReference(text) | Text(text) => {
+                if Some(&text) == in_link.as_ref() {
+                    // Probably a link of the form `<http://example.com>`
+                    // Which are represented as a link to "http://example.com" with
+                    // text "http://example.com" by pulldown-cmark
+                    continue;
+                }
+
                 if !in_code {
                     let index = match spans.binary_search_by(|c| c.0.cmp(&offset)) {
                         Ok(o) => o,
@@ -270,6 +281,18 @@ fn check_word(cx: &EarlyContext, word: &str, span: Span) {
         s != "_" && !s.contains("\\_") && s.contains('_')
     }
 
+    if let Ok(url) = Url::parse(word) {
+        // try to get around the fact that `foo::bar` parses as a valid URL
+        if !url.cannot_be_a_base() {
+            span_lint(cx,
+                      DOC_MARKDOWN,
+                      span,
+                      "you should put bare URLs between `<`/`>` or make a proper Markdown link");
+
+            return;
+        }
+    }
+
     if has_underscore(word) || word.contains("::") || is_camel_case(word) {
         span_lint(
             cx,

clippy_lints/src/doc.rs

@@ -51,6 +51,7 @@ extern crate lazy_static;
 
 extern crate itertools;
 extern crate pulldown_cmark;
+extern crate url;
 
 macro_rules! declare_restriction_lint {
     { pub $name:tt, $description:tt } => {

clippy_lints/src/lib.rs

@@ -159,3 +159,11 @@ fn issue_1469() {}
  *This would also be an error under a strict common mark interpretation
  */
 fn issue_1920() {}
+
+/// Ok: <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
+///
+/// Not ok: http://www.unicode.org
+/// Not ok: https://www.unicode.org
+/// Not ok: http://www.unicode.org/
+/// Not ok: http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels
+fn issue_1832() {}

tests/ui/doc.rs

@@ -156,5 +156,29 @@ error: you should put `be_sure_we_got_to_the_end_of_it` between ticks in the doc
 138 | /// be_sure_we_got_to_the_end_of_it
     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-error: aborting due to 26 previous errors
+error: you should put bare URLs between `<`/`>` or make a proper Markdown link
+   --> $DIR/doc.rs:165:13
+    |
+165 | /// Not ok: http://www.unicode.org
+    |             ^^^^^^^^^^^^^^^^^^^^^^
+
+error: you should put bare URLs between `<`/`>` or make a proper Markdown link
+   --> $DIR/doc.rs:166:13
+    |
+166 | /// Not ok: https://www.unicode.org
+    |             ^^^^^^^^^^^^^^^^^^^^^^^
+
+error: you should put bare URLs between `<`/`>` or make a proper Markdown link
+   --> $DIR/doc.rs:167:13
+    |
+167 | /// Not ok: http://www.unicode.org/
+    |             ^^^^^^^^^^^^^^^^^^^^^^
+
+error: you should put bare URLs between `<`/`>` or make a proper Markdown link
+   --> $DIR/doc.rs:168:13
+    |
+168 | /// Not ok: http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels
+    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: aborting due to 30 previous errors