Lint csl-json blocks

ethereum · Dec 6, 2022 · 453daf4 · 453daf4
1 parent f0e4bab
commit 453daf4
Show file tree

Hide file tree

Showing 13 changed files with 1,296 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -64,6 +64,7 @@ error[preamble-order]: preamble header `description` must come after `title`
 
 | id                                  | Description                                                                                   |
 |-------------------------------------|-----------------------------------------------------------------------------------------------|
+| `markdown-json-cite`                | All `csl-json` code blocks adhere to the correct schema.                                      |
 | `markdown-link-first`               | First mention of an EIP must be a link.                                                       |
 | `markdown-link-status`              | EIPs linked in the body have statuses further along than the current proposal.                |
 | `markdown-order-section`            | There are no extra sections and the sections are in the correct order.                        |

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.5"
+version = "0.2.6"
 edition = "2021"
 license = "MPL-2.0"
 rust-version = "1.60"
@@ -27,6 +27,7 @@ eipw-lint = { version = "0.2.0", path = "../eipw-lint" }
 js-sys = "0.3.60"
 serde_json = "1.0.86"
 serde = { version = "1.0", features = [ "derive" ] }
+getrandom = { version = "0.2.8", features = [ "js" ] }
 
 [dev-dependencies]
 wasm-bindgen-test = "0.3.33"

diff --git a/eipw-lint/Cargo.toml b/eipw-lint/Cargo.toml
@@ -20,6 +20,7 @@ chrono = { version = "0.4.22", default-features = false }
 educe = { version = "0.4.19", default-features = false, features = [ "Debug" ] }
 tokio = { optional = true, version = "1.21.2", features = [ "macros" ] }
 scraper = { version = "0.13.0", default-features = false }
+jsonschema = { version = "0.16.1", default-features = false }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 tokio = { version = "1.21.2", features = [ "fs", "macros" ] }

diff --git a/eipw-lint/src/lib.rs b/eipw-lint/src/lib.rs
@@ -368,7 +368,25 @@ pub fn default_lints() -> impl Iterator<Item = (&'static str, Box<dyn Lint>)> {
                     &["Final", "Withdrawn", "Living"],
                 ]
             }.boxed(),
-        )
+        ),
+        (
+            "markdown-json-cite",
+            markdown::JsonSchema {
+                additional_schemas: &[
+                    (
+                        "https://resource.citationstyles.org/schema/v1.0/input/json/csl-data.json",
+                        include_str!("lints/markdown/json_schema/csl-data.json"),
+                    ),
+                ],
+                schema: include_str!("lints/markdown/json_schema/citation.json"),
+                language: "csl-json",
+                help: concat!(
+                    "see https://github.com/ethereum/eipw/blob/",
+                    "master/eipw-lint/src/lints/markdown/",
+                    "json_schema/citation.json",
+                ),
+            }.boxed(),
+        ),
     ]
     .into_iter()
 }
@@ -740,6 +758,7 @@ fn process<'r, 'a>(
         extension: ComrakExtensionOptions {
             table: true,
             autolink: true,
+            footnotes: true,
             ..Default::default()
         },
         ..Default::default()