tier 0.1.17

Rust configuration library for layered TOML, env, and CLI settings
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use serde_json::Value;

use crate::ConfigMetadata;

use super::comments::{
    render_toml_array_table_item_comments, render_toml_comments,
    render_toml_inline_array_item_comments,
};
use super::path::{
    join_metadata_path, resolve_toml_array_item_metadata_path,
    resolve_toml_object_child_metadata_path,
};
use super::value::{
    is_nested_toml_value, start_toml_section, toml_inline_value, toml_key, toml_table_name,
};

pub(super) fn render_example_toml(value: &Value, metadata: &ConfigMetadata) -> String {
    let mut output = String::new();
    render_toml_root_comments(metadata, &mut output);
    match value {
        Value::Object(root) => render_toml_table("", "", root, metadata, &mut output),
        other => render_toml_root_value(other, metadata, &mut output),
    }

    if !output.ends_with('\n') {
        output.push('\n');
    }

    output
}

fn render_toml_root_value(value: &Value, metadata: &ConfigMetadata, output: &mut String) {
    if matches!(value, Value::Array(_)) {
        render_toml_inline_array_item_comments("", metadata, output);
    }

    output.push_str(
        "# root values are rendered as comments because TOML documents require a table at the top level\n",
    );
    output.push_str("# ");
    output.push_str(&toml_inline_value(value));
    output.push('\n');
}

fn render_toml_root_comments(metadata: &ConfigMetadata, output: &mut String) {
    if metadata.checks().is_empty() {
        return;
    }

    for check in metadata.checks() {
        output.push_str("# validate: ");
        output.push_str(&check.to_string());
        output.push('\n');
    }

    output.push('\n');
}

fn render_toml_table(
    display_path: &str,
    metadata_path: &str,
    table: &serde_json::Map<String, Value>,
    metadata: &ConfigMetadata,
    output: &mut String,
) {
    let mut nested = Vec::new();

    for (key, value) in table {
        if value.is_null() {
            continue;
        }

        if is_nested_toml_value(value) {
            nested.push((key.as_str(), value));
            continue;
        }

        let metadata_child_path =
            resolve_toml_object_child_metadata_path(metadata_path, key, metadata);
        render_toml_comments(&metadata_child_path, metadata, output);
        if matches!(value, Value::Array(_)) {
            render_toml_inline_array_item_comments(&metadata_child_path, metadata, output);
        }
        output.push_str(&toml_key(key));
        output.push_str(" = ");
        output.push_str(&toml_inline_value(value));
        output.push('\n');
    }

    let nested_count = nested.len();
    for (index, (key, value)) in nested.into_iter().enumerate() {
        let display_child_path = join_metadata_path(display_path, key);
        let metadata_child_path =
            resolve_toml_object_child_metadata_path(metadata_path, key, metadata);
        match value {
            Value::Object(child) => {
                start_toml_section(output);
                render_toml_comments(&metadata_child_path, metadata, output);
                output.push('[');
                output.push_str(&toml_table_name(&display_child_path));
                output.push_str("]\n");
                render_toml_table(
                    &display_child_path,
                    &metadata_child_path,
                    child,
                    metadata,
                    output,
                );
            }
            Value::Array(items) => {
                for (item_index, item) in items.iter().enumerate() {
                    let Some(child) = item.as_object() else {
                        continue;
                    };
                    let item_metadata_path = resolve_toml_array_item_metadata_path(
                        &metadata_child_path,
                        item_index,
                        metadata,
                    );
                    start_toml_section(output);
                    if item_index == 0 {
                        render_toml_comments(&metadata_child_path, metadata, output);
                    }
                    render_toml_array_table_item_comments(&item_metadata_path, metadata, output);
                    output.push_str("[[");
                    output.push_str(&toml_table_name(&display_child_path));
                    output.push_str("]]\n");
                    render_toml_table(
                        &display_child_path,
                        &item_metadata_path,
                        child,
                        metadata,
                        output,
                    );
                }
            }
            _ => {}
        }

        if index + 1 < nested_count && !output.ends_with("\n\n") {
            output.push('\n');
        }
    }
}