Allow links to devp2p specs

ethereum · Dec 6, 2022 · b4c2124 · b4c2124
1 parent 27851cf
commit b4c2124
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 30 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ members = [ "eipw-lint", "eipw-lint-js" ]
 [package]
 name = "eipw"
 description = "Ethereum Improvement Proposal linter that's one more than eipv"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 license = "MPL-2.0"
 rust-version = "1.65"
@@ -16,7 +16,7 @@ repository = "https://github.com/ethereum/eipw"
 annotate-snippets = "0.9.1"
 tokio = { version = "1.21.2", features = [ "macros" ] }
 clap = { version = "4.0.17", features = [ "derive" ] }
-eipw-lint = { version = "0.2.0", path = "eipw-lint", features = [ "tokio" ] }
+eipw-lint = { version = "0.3.0", path = "eipw-lint", features = [ "tokio" ] }
 serde_json = "1.0.86"
 thiserror = "1.0.37"
 

diff --git a/eipw-lint-js/Cargo.toml b/eipw-lint-js/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "eipw-lint-js"
-version = "0.2.6"
+version = "0.3.0"
 edition = "2021"
 license = "MPL-2.0"
 rust-version = "1.65"
@@ -23,7 +23,7 @@ wasm-bindgen = { version = "0.2.83", features = [ "serde-serialize" ] }
 serde-wasm-bindgen = "0.4.5"
 wasm-bindgen-futures = "0.4.33"
 console_error_panic_hook = { version = "0.1.7", optional = true }
-eipw-lint = { version = "0.2.0", path = "../eipw-lint" }
+eipw-lint = { version = "0.3.0", path = "../eipw-lint" }
 js-sys = "0.3.60"
 serde_json = "1.0.86"
 serde = { version = "1.0", features = [ "derive" ] }

diff --git a/eipw-lint/Cargo.toml b/eipw-lint/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "eipw-lint"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 license = "MPL-2.0"
 rust-version = "1.65"

diff --git a/eipw-lint/src/lib.rs b/eipw-lint/src/lib.rs
@@ -356,7 +356,12 @@ pub fn default_lints() -> impl Iterator<Item = (&'static str, Box<dyn Lint>)> {
             "markdown-link-first",
             markdown::LinkFirst(r"(?i)eip-[0-9]+").boxed(),
         ),
-        ("markdown-rel-links", markdown::RelativeLinks.boxed()),
+        ("markdown-rel-links", markdown::RelativeLinks {
+            exceptions: &[
+                "^https://(www\\.)?github\\.com/ethereum/consensus-specs/blob/[a-f0-9]{40}/.+$",
+                "^https://(www\\.)?github\\.com/ethereum/devp2p/blob/[0-9a-f]{40}/.+$"
+            ]
+        }.boxed()),
         (
             "markdown-link-status",
             markdown::LinkStatus {

diff --git a/eipw-lint/src/lints/markdown/relative_links.rs b/eipw-lint/src/lints/markdown/relative_links.rs
@@ -11,31 +11,31 @@ use comrak::nodes::Ast;
 use crate::lints::{Context, Error, Lint};
 use crate::tree::{self, Next, TraverseExt};
 
-use regex::bytes::Regex;
+use regex::bytes::{Regex, RegexSet};
 
 use scraper::node::Node as HtmlNode;
 use scraper::Html;
 
 use snafu::Snafu;
 
 #[derive(Debug)]
-pub struct RelativeLinks;
+pub struct RelativeLinks<'e> {
+    pub exceptions: &'e [&'e str],
+}
 
-impl Lint for RelativeLinks {
+impl<'e> Lint for RelativeLinks<'e> {
     fn lint<'a, 'b>(&self, slug: &'a str, ctx: &Context<'a, 'b>) -> Result<(), Error> {
         let re = Regex::new("(^/)|(://)").unwrap();
-        let cs_re = Regex::new(
-            "^https://(www\\.)?github\\.com/ethereum/consensus-specs/blob/[a-f0-9]{40}/.+$",
-        )
-        .unwrap();
+
+        let exceptions = RegexSet::new(self.exceptions).map_err(Error::custom)?;
 
         let mut visitor = Visitor::default();
         ctx.body().traverse().visit(&mut visitor)?;
 
         let links = visitor
             .links
             .into_iter()
-            .filter(|l| re.is_match(&l.address) && !cs_re.is_match(&l.address));
+            .filter(|l| re.is_match(&l.address) && !exceptions.is_match(&l.address));
 
         for Link { line_start, .. } in links {
             ctx.report(Snippet {

diff --git a/eipw-lint/tests/lint_markdown_relative_links.rs b/eipw-lint/tests/lint_markdown_relative_links.rs
@@ -19,7 +19,14 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny(
+            "markdown-rel",
+            RelativeLinks {
+                exceptions: &[
+                    "^https://(www\\.)?github\\.com/ethereum/consensus-specs/blob/[a-f0-9]{40}/.+$",
+                ],
+            },
+        )
         .check_slice(None, src)
         .run()
         .await
@@ -40,7 +47,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -68,7 +75,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -96,7 +103,7 @@ Hello [hi](/foo)!
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -124,7 +131,7 @@ Hello [hi](./foo/bar)!
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -147,7 +154,7 @@ Hello [hi][hello]!
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -177,7 +184,7 @@ Hello [hi][hello]!
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -198,7 +205,7 @@ https://example.com/
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -226,7 +233,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -254,7 +261,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -282,7 +289,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -303,7 +310,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await
@@ -324,7 +331,7 @@ header: value1
 
     let reports = Linter::<Text<String>>::default()
         .clear_lints()
-        .deny("markdown-rel", RelativeLinks)
+        .deny("markdown-rel", RelativeLinks { exceptions: &[] })
         .check_slice(None, src)
         .run()
         .await