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
|
# yamlpatch
[](https://zizmor.sh/)
[](https://github.com/zizmorcore/zizmor/actions/workflows/ci.yml)
[](https://crates.io/crates/yamlpatch)
[](https://docs.rs/yamlpatch)
[](https://github.com/sponsors/woodruffw)
[](https://discord.com/invite/PGU3zGZuGG)
Comment and format-preserving YAML patch operations.
`yamlpatch` builds on [`yamlpath`] to provide surgical modification capabilities
while preserving comments, formatting, and structure.
[`yamlpath`]: https://github.com/zizmorcore/zizmor/tree/main/crates/yamlpath
> [!IMPORTANT]
>
> This is not a substitute for comprehensive YAML processing libraries.
> It's designed for targeted modifications that preserve the original
> document's formatting and comments.
## Why?
When working with YAML configuration files, it's often necessary to make
programmatic changes while preserving the human-readable aspects of the
file: comments, formatting, indentation, and style choices.
Traditional YAML processing involves parsing to a document model, making
changes, and re-serializing. This approach *destroys* the original formatting
and comments, making the result less suitable for version control and
human review.
`yamlpatch` solves this by providing targeted patch operations that:
- Preserve comments and their positioning
- Maintain original indentation and formatting
- Respect different YAML styles (block vs. flow, single vs. multi-line)
- Support precise fragment rewriting within string values
- Handle complex nested structures gracefully
## Operations
`yamlpatch` supports several types of patch operations:
- **Replace**: Replace a value at a specific path
- **Add**: Add new key-value pairs to mappings
- **Remove**: Remove keys or elements
- **MergeInto**: Merge values into existing mappings
- **RewriteFragment**: Rewrite portions of string values (useful for templating)
Each operation is designed to work with the existing document structure
and formatting, making minimal changes while achieving the desired result.
## License
MIT License.
|
