cool-diff 0.1.0

Compact, context-preserving diffs of structured data (serde_json::Value)
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
34
35
36
37
38
39
40
41
42
43
44
45
46

use cool_diff::{
    ArrayMatchConfig, ArrayMatchMode, DiffConfig, DiffRenderer as _, MatchConfig, YamlRenderer,
};

/// Demonstrates custom match configs with a mix of ordered and unordered arrays.
///
/// - `steps` uses index-based matching (order matters, like a pipeline).
/// - `tags` uses contains matching (just check presence, order irrelevant).
/// - `contributors` uses key-based matching on `email`.
fn main() {
    let actual = serde_json::json!({
        "project": "cool-diff",
        "steps": ["build", "test", "deploy"],
        "tags": ["rust", "diff", "yaml"],
        "contributors": [
            {"email": "alice@example.com", "role": "maintainer"},
            {"email": "bob@example.com", "role": "contributor"},
        ],
    });

    let expected = serde_json::json!({
        "project": "cool-diff",
        "steps": ["build", "lint", "deploy"],
        "tags": ["yaml"],
        "contributors": [
            {"email": "bob@example.com", "role": "reviewer"},
        ],
    });

    let config = DiffConfig::new().with_match_config(
        MatchConfig::new()
            // steps: order matters (index-based is the default, shown explicitly)
            .with_config_at("steps", ArrayMatchConfig::new(ArrayMatchMode::Index))
            // tags: just check presence
            .with_config_at("tags", ArrayMatchConfig::new(ArrayMatchMode::Contains))
            // contributors: match by email
            .with_config_at(
                "contributors",
                ArrayMatchConfig::new(ArrayMatchMode::Key("email".to_owned())),
            ),
    );

    let tree = cool_diff::diff(&actual, &expected, &config).unwrap();
    let output = YamlRenderer::new().render(&tree);
    print!("{output}");
}