jsonschema-explain 0.1.0

Render JSON Schema as human-readable terminal documentation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# jsonschema-explain

[![Crates.io](https://img.shields.io/crates/v/jsonschema-explain.svg)](https://crates.io/crates/jsonschema-explain)
[![docs.rs](https://docs.rs/jsonschema-explain/badge.svg)](https://docs.rs/jsonschema-explain)
[![CI](https://github.com/lintel-rs/lintel/actions/workflows/ci.yml/badge.svg)](https://github.com/lintel-rs/lintel/actions/workflows/ci.yml)
[![License](https://img.shields.io/crates/l/jsonschema-explain.svg)](https://github.com/lintel-rs/lintel/blob/master/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

```rust
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](https://github.com/lintel-rs/lintel) project.

## License

Apache-2.0