saneyaml 0.3.0

Pure-Rust YAML parser, emitter, and Serde compatibility layer for developer configuration files.
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
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

fn main() -> saneyaml::Result<()> {
    docker_compose_edit()?;
    kubernetes_label_edit()?;
    github_actions_edit()?;
    Ok(())
}

fn docker_compose_edit() -> saneyaml::Result<()> {
    let source = "\
# service stack
services:
  web:
    image: nginx:1.25
    ports:
      - \"80:80\"
";
    let mut editor = saneyaml::edit(source)?;
    editor
        .set(
            saneyaml::ConfigPath::new([
                saneyaml::PathSegment::from("services"),
                saneyaml::PathSegment::from("web"),
                saneyaml::PathSegment::from("image"),
            ]),
            "nginx:1.27",
        )?
        .push(
            saneyaml::ConfigPath::new([
                saneyaml::PathSegment::from("services"),
                saneyaml::PathSegment::from("web"),
                saneyaml::PathSegment::from("ports"),
            ]),
            "8080:80",
        )?;

    let edited = editor.finish()?;
    assert!(edited.contains("# service stack"));
    assert!(edited.contains("image: nginx:1.27"));
    assert!(edited.contains("- 8080:80"));
    Ok(())
}

fn kubernetes_label_edit() -> saneyaml::Result<()> {
    let source = "\
metadata:
  labels:
    app.kubernetes.io/name: web
";
    let mut editor = saneyaml::edit(source)?;
    editor.set(
        saneyaml::ConfigPath::json_pointer("/metadata/labels/app.kubernetes.io~1name")?,
        "api",
    )?;

    let edited = editor.finish()?;
    assert!(edited.contains("app.kubernetes.io/name: api"));
    Ok(())
}

fn github_actions_edit() -> saneyaml::Result<()> {
    let source = "\
jobs:
  test:
    steps:
      - uses: actions/checkout@v4
      - run: cargo test
";
    let mut editor = saneyaml::edit(source)?;
    editor.set(
        saneyaml::ConfigPath::new([
            saneyaml::PathSegment::from("jobs"),
            saneyaml::PathSegment::from("test"),
            saneyaml::PathSegment::from("steps"),
            saneyaml::PathSegment::from(0usize),
            saneyaml::PathSegment::from("uses"),
        ]),
        "actions/checkout@v6",
    )?;

    let edited = editor.finish()?;
    assert!(edited.contains("uses: actions/checkout@v6"));
    assert!(edited.contains("- run: cargo test"));
    Ok(())
}