diffx 0.6.1

Smart diff for config files. Compare JSON/YAML/TOML/XML semantically. Features: ignore patterns, array tracking, directory compare, JSON/YAML output
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# diffx

[![CI](https://github.com/kako-jun/diffx/actions/workflows/ci.yml/badge.svg)](https://github.com/kako-jun/diffx/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/diffx.svg)](https://crates.io/crates/diffx)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

Semantic diff tool for structured data (JSON/YAML/TOML/XML/INI/CSV). Ignores key ordering and whitespace, shows only meaningful changes.

## Why diffx?

Traditional `diff` doesn't understand structure:

```bash
$ diff config_v1.json config_v2.json
< {
<   "name": "myapp",
<   "version": "1.0"
< }
> {
>   "version": "1.1",
>   "name": "myapp"
> }
```

A simple key reordering shows every line as changed.

`diffx` shows only semantic changes:

```bash
$ diffx config_v1.json config_v2.json
~ version: "1.0" -> "1.1"
```

## Installation

```bash
# As CLI tool
cargo install diffx

# As library (Cargo.toml)
[dependencies]
diffx-core = "0.6"
```

## Usage

```bash
# Basic
diffx file1.json file2.json

# Output example
~ version: "1.0" -> "1.1"
+ features[0]: "new-feature"
- deprecated: "old-value"
```

## Supported Formats

JSON, YAML, TOML, XML, INI, CSV (auto-detected by extension, use `--format` to override)

## Main Options

```bash
--output json|yaml       # Machine-readable output
--quiet                  # Return only exit code (0: same, 1: diff found)
--ignore-keys-regex RE   # Ignore keys matching regex
--array-id-key KEY       # Identify array elements by KEY for comparison
--epsilon N              # Float comparison tolerance
--ignore-case            # Case-insensitive comparison
--ignore-whitespace      # Ignore whitespace differences
-r, --recursive          # Recursive directory comparison
```

## Output Symbols

- `+` Added
- `-` Removed
- `~` Modified
- `!` Type changed

## CI/CD Usage

```bash
# Detect config changes
if ! diffx config/prod.json config/staging.json --quiet; then
  echo "Config has changed"
  diffx config/prod.json config/staging.json --output json > changes.json
fi

# Compare ignoring timestamps and metadata
diffx api_v1.json api_v2.json --ignore-keys-regex "^(timestamp|updated_at)$"
```

## Documentation

- [CLI Specification](docs/specs/cli.md)
- [Core API Specification](docs/specs/core.md)
- [Examples](diffx-cli/tests/cmd/)

## License

MIT