Repository navigation
fix(kyaml): escape U+2028 and U+2029 so keys stay parseable by yq - #250
Merged
hyperpolymath merged 1 commit intoOct 26, 2026
Merged
Conversation
go-yaml, the parser behind yq and standards' kyaml-format.sh, reads a
raw LS or PS as a line break (YAML 1.1 behaviour). In a key that makes
the document unparseable: `{"x<LS>y": 1}` written by `--output-format
kyaml` failed with "did not find expected ',' or '}'". NEL was already
escaped; LS and PS now are too, as `
` / `
`, which is valid
in YAML 1.1 and 1.2. serde-saphyr read the files correctly either way.
A new test covers NEL, LS and PS in keys; it fails on the previous
escape set with the raw separator in the output.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PFaqv6iBXrt3W5Akd1Fq5k
Contributor
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Escape and validate Unicode separators src/kyaml.rs, CHANGELOG.adoc |
write_quoted escapes U+2028 and U+2029. The documentation and changelog describe the escape behaviour and parser handling. Tests cover value escaping and verify that keys containing NEL, U+2028 or U+2029 parse back to the original value. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Bug fix
Possibly related PRs
- hyperpolymath/panic-attack#234: Introduced
crate::yamlparsing and initial KYAML support.
Suggested reviewers: metadatastician
Merge Risk: 
e914d
-
The change is mergeable with no identified current-head risk.
Pre-merge checks: 
-
Check name Status Explanation Resolution Docstring Coverage Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold. -
Check name Status Explanation Title check The title clearly and concisely identifies the main change: escaping U+2028 and U+2029 in KYAML so keys remain parseable by yq. Description check The description directly explains the parsing problem, the KYAML fix, the tests, validation results, and the remaining yq limitation. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 1 files. (1 skipped: 1 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches: 💡 1
-
📝 Generate docstrings: 💡
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
hyperpolymath
deleted the
claude/gallant-bell-4bo4oy-g-kyaml-line-separators
branch
October 26, 2026 22:28
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #248 (KYAML report output), found while drafting the upstream yq issue about its KYAML encoder.
Problem
go-yaml, the parser behind
yqand standards'scripts/kyaml-format.sh, treats a raw U+2028 (LS) or U+2029 (PS) as a line break, which is YAML 1.1 behaviour. Our emitter already escaped NEL (U+0085) but wrote LS and PS raw. A report key holding either one therefore produced KYAML thatyqcould not read at all:Values were unaffected, and
crate::yaml(serde-saphyr, YAML 1.2) read these files correctly before and after. In #248 I deliberately left U+2028 raw because YAML 1.2 calls it printable. Testing keys showed that was the wrong call for interop.Fix
write_quotedalso escapes U+2028 and U+2029 asValidation
cargo fmt --check, pluscargo clippy --all-targets -D warningswith and without--all-features: clean.cargo test --all-features: all suites green (lib: 510 passed).line_breaks_in_keys_are_escapedcovers NEL, LS and PS in keys: exact output, and a round trip throughcrate::yaml. Run against the previous escape set, it fails with the raw separator in the output ("x\u{2028}y").escapes_non_printables_that_yq_writes_rawis updated: it asserted LS stays raw, and now asserts it is escaped.yqv4.54.1: KYAML from this branch with NEL, LS or PS in a key reads back intact (yq -p yaml -o json).One thing this PR can't fix
kyaml-format.sh --checkstill refuses these files:REFUSED — the KYAML rendering does not parse to the same data. The gate re-renders throughyq -o kyaml, and yq's encoder writes the characters raw again. That is the upstream yq bug:yqbuilt from my proposed upstream patch, the same three files pass (all 3 file(s) are KYAML).Until yq is fixed, a report key containing NEL, LS or PS can't pass the gate. Such keys are rare in practice, since report keys are field names and file paths.
Generated by Claude Code