Skip to content

Commit adb4347

Browse files
committed
docs: add remaining drift fixes — YAML quoted strings and README callout
Document that YAML quoted strings are normalized to bare scalars on output (e.g. "100m" → 100m), affecting all keys not just those touched by the query. This was the last undocumented behavior from the drift audit. Add a "Known behaviors" callout to the README formats section listing all five normalization behaviors in one place: comment stripping, YAML anchor expansion, quoted-string normalization, TOML inline-table rewrite, and JSON compact output.
1 parent 757bfa8 commit adb4347

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ nesdit -i deploy.yaml --argjson replicas "$REPLICAS" --query '.replicas = $repli
6363
| YAML | `.yaml`, `.yml` | Single-document per file; anchors/aliases resolved on decode, not re-emitted |
6464
| TOML | `.toml` | Tables and arrays of tables; nested tables emitted as inline syntax |
6565

66+
> **Known behaviors:** Comments are stripped from all formats on output. YAML anchors/aliases are resolved and not re-emitted. YAML quoted strings are normalized to bare scalars. TOML `[section]` headers are rewritten to inline-table syntax (`{key = value}`). JSON output is always compact (single-line). None of these affect the parsed value — only the serialized form.
67+
6668
Format is auto-detected from the file extension. Use `--format json|jsonl|yaml|toml` to override input format, and `--output-format json|yaml|toml` to transcode to a different output format.
6769

6870
## Key flags

docs/examples/formats/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- **Comments** are not preserved across round-trips. This is an explicit non-goal for v1. If your files contain comments that matter, keep the source-of-truth file elsewhere and generate the deployed copy from it.
77
- **YAML anchors and aliases** are resolved on decode and not re-emitted. Output always contains the fully expanded values, not the original anchor references.
88
- **JSON output is always compact** (single-line, no indentation). `--pretty` currently only affects TOML output.
9+
- **YAML quoted strings** are normalized to bare scalars on output. A value like `"100m"` becomes `100m`. This applies to all keys in the document, not only those touched by the query.
910

1011
## JSON → JSON
1112

0 commit comments

Comments
 (0)