wip

Author: untitaker

Cargo.toml

@@ -2,6 +2,7 @@
 name = "json-schema-diff"
 version = "0.1.0"
 edition = "2021"
+license = "Apache 2.0"
 
 [lib]
 name = "json_schema_diff"

README.md

@@ -0,0 +1,50 @@
+# json-schema-diff
+
+A work-in-progress tool to diff changes between code schemas. A lot of JSON schema features are not implemented and therefore ignored, such as:
+
+* `required`
+* `patternProperties` (entirely ignored)
+* `const` (changes from `{"const": "foo"}` to `{"type": "string"}` are not detected)
+
+Use this tool as a best-effort to find obviously breaking changes in CI, but not for much more.
+
+This crate is used with draft-07 but even that is work in progress.
+
+## Usage via CLI
+
+```bash
+cargo run --features=build-binary -- \
+    schema-old.json \
+    schema-new.json
+```
+
+## Usage as library
+
+```rust
+use json_schema_diff::*;
+
+let lhs = serde_json::json! {{ 
+    "type": "string",
+}};
+let rhs = serde_json::json! {{ 
+    "type": "boolean",
+}};
+
+assert_eq!(
+    json_schema_diff::diff(lhs, rhs).unwrap(),
+    vec![
+        Change {
+            path: "".to_owned(),
+            change: ChangeKind::TypeRemove { removed: SimpleJsonSchemaType::String }
+        },
+        Change {
+            path: "".to_owned(),
+            change: ChangeKind::TypeAdd { added: SimpleJsonSchemaType::Boolean }
+        }
+    ]
+);
+```
+
+## License
+
+Licensed under Apache 2.0, see `./LICENSE`

src/bin/main.rs

@@ -2,7 +2,6 @@ use clap::Parser;
 use std::fs::File;
 use std::path::PathBuf;
 
-
 use anyhow::Error;
 
 /// Compare old and new schema, and print differences
@@ -24,7 +23,7 @@ fn main() -> Result<(), Error> {
     let changes = json_schema_diff::diff(lhs, rhs)?;
 
     for change in changes {
-        println!("{:?}", change);
+        println!("{}", serde_json::to_string(&change)?);
     }
     Ok(())
 }