Skip to main content

Crate jsonschema_explain

Crate jsonschema_explain 

Source
Expand description

§jsonschema-explain

Crates.io docs.rs CI License

Render JSON Schema as human-readable terminal documentation

§Features

  • Man-page-style terminal output from serde_json::Value schemas
  • ANSI colors with bold headers, dimmed metadata, and highlighted types
  • Syntax-highlighted code blocks in schema descriptions (via markdown-to-ansi)
  • Renders properties, required fields, enums, defaults, oneOf/anyOf/allOf variants
  • Auto-sizes to terminal width

§Usage

use jsonschema_explain::explain;
use serde_json::Value;

let schema: Value = serde_json::from_str(r#"{"type": "object"}"#).unwrap();
let output = explain(&schema, "my-config", true, true);
println!("{output}");

Part of the Lintel project.

§License

Apache-2.0

Functions§

explain
Render a JSON Schema as human-readable terminal documentation.