jsondoclint: Tree Walk Validator

Author: aDotInTheVoid

Cargo.lock

@@ -103,9 +103,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.60"
+version = "1.0.65"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c794e162a5eff65c72ef524dfe393eb923c354e350bb78b9c7383df13f3bc142"
+checksum = "98161a4e3e2184da77bb14f02184cdd111e83bbbcc9979dfee3c44b9a85f5602"
 
 [[package]]
 name = "array_tool"
@@ -1362,9 +1362,9 @@ dependencies = [
 
 [[package]]
 name = "fs-err"
-version = "2.5.0"
+version = "2.8.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bcd1163ae48bda72a20ae26d66a04d3094135cadab911cff418ae5e33f253431"
+checksum = "64db3e262960f0662f43a6366788d5f10f7f244b8f7d7d987f560baf5ded5c50"
 
 [[package]]
 name = "fs_extra"
@@ -1894,6 +1894,12 @@ dependencies = [
 [[package]]
 name = "jsondoclint"
 version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "fs-err",
+ "rustdoc-json-types",
+ "serde_json",
+]
 
 [[package]]
 name = "jsonpath_lib"
@@ -4449,9 +4455,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.83"
+version = "1.0.85"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "38dd04e3c8279e75b31ef29dbdceebfe5ad89f4d0937213c53f7d49d01b3d5a7"
+checksum = "e55a28e3aaef9d5ce0506d0a14dbba8054ddc7e499ef522dd8b26859ec9d4a44"
 dependencies = [
  "indexmap",
  "itoa",

src/tools/jsondoclint/Cargo.toml

@@ -6,3 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+anyhow = "1.0.62"
+fs-err = "2.8.1"
+rustdoc-json-types = { version = "0.1.0", path = "../../rustdoc-json-types" }
+serde_json = "1.0.85"

src/tools/jsondoclint/src/item_kind.rs

@@ -0,0 +1,29 @@
+use rustdoc_json_types::ItemEnum;
+
+pub(crate) fn can_appear_in_mod(kind: &ItemEnum) -> bool {
+    match kind {
+        ItemEnum::Module(_) => true,
+        ItemEnum::ExternCrate { .. } => true,
+        ItemEnum::Import(_) => true,
+        ItemEnum::Union(_) => true,
+        ItemEnum::Struct(_) => true,
+        ItemEnum::StructField(_) => false, // Only in structs or variants
+        ItemEnum::Enum(_) => true,
+        ItemEnum::Variant(_) => false, // Only in enums
+        ItemEnum::Function(_) => true,
+        ItemEnum::Trait(_) => true,
+        ItemEnum::TraitAlias(_) => true,
+        ItemEnum::Method(_) => false, // Only in traits
+        ItemEnum::Impl(_) => true,
+        ItemEnum::Typedef(_) => true,
+        ItemEnum::OpaqueTy(_) => todo!("IDK"), // On
+        ItemEnum::Constant(_) => true,
+        ItemEnum::Static(_) => true,
+        ItemEnum::ForeignType => todo!("IDK"),
+        ItemEnum::Macro(_) => true,
+        ItemEnum::ProcMacro(_) => true,
+        ItemEnum::PrimitiveType(_) => todo!("IDK"),
+        ItemEnum::AssocConst { .. } => false, // Trait Only
+        ItemEnum::AssocType { .. } => false,  // Trait only
+    }
+}

src/tools/jsondoclint/src/main.rs

@@ -1 +1,33 @@
-fn main() {}
+use std::env;
+
+use anyhow::{anyhow, bail, Result};
+use fs_err as fs;
+use rustdoc_json_types::{Crate, Id, FORMAT_VERSION};
+
+pub(crate) mod item_kind;
+mod validator;
+
+#[derive(Debug)]
+struct Error {
+    message: String,
+    id: Id,
+}
+
+fn main() -> Result<()> {
+    let path = env::args().nth(1).ok_or_else(|| anyhow!("no path given"))?;
+    let contents = fs::read_to_string(path)?;
+    let krate: Crate = serde_json::from_str(&contents)?;
+    assert_eq!(krate.format_version, FORMAT_VERSION);
+
+    let mut validator = validator::Validator::new(&krate);
+    validator.check_crate();
+
+    if !validator.errs.is_empty() {
+        for err in validator.errs {
+            eprintln!("`{}`: `{}`", err.id.0, err.message);
+        }
+        bail!("Errors validating json");
+    }
+
+    Ok(())
+}