Repository navigation
fix(yaml): comments can be key-values - #1289
Merged
Merged
Conversation
This fixes a bug where comments that come after a name tag and contain a
colon character are parsed as key-value pair instead of as comment.
For example, the following YAML is parsed as having the key
`version: 2 # Required`:
version: 2 # Required: Configuration format version
Therefore, this makes the `NameTag` regex stricter and doesn't allow the
hash character in name tags, avoiding the bad parsing.
A current example of how this breaks in practice is our GitLab Caproni
docs site [1], which uses imfing/hextra, which uses Chroma. The YAML
comments are treated partially as keys instead of comments.
[1]: https://gitlab-org.gitlab.io/caproni/config/
alecthomas
approved these changes
Jun 17, 2026
alecthomas
enabled auto-merge (squash)
June 17, 2026 00:08
alecthomas
pushed a commit
that referenced
this pull request
Oct 16, 2026
Addresses #1333. YAML uses `#` for comments ([YAML 1.2.2 §6.6](https://yaml.org/spec/1.2.2/#66-comments)). The `//` rules added in #1278 instead consume valid plain scalars and prevent slash-containing keys from matching: ```yaml path: //server/share proto: //cdn.example.com/lib.js text: prefix // suffix //key: value ``` Remove both slash-comment rules and their exclusions in the key patterns. Keep the `#` exclusions from #1289 and leave the numeric changes in #1372 separate. The fixture replaces the invalid trailing-`//` comment examples with valid quoted strings, plain scalars, keys, sequence items, and a real `#` comment containing a colon. The new expectations fail with the original lexer and pass with this change. ### Validation Using the repository's Hermit toolchain (Go 1.26.6): - `go test -count=1 ./...` - `go test -race -count=1 ./...` - `just check-generated` — no generated changes - `golangci-lint run` - `git diff --check` Also checked actual CLI output for 25 parser-valid examples: 14 regressions are corrected and 11 controls are unchanged. HTML output keeps real hash comments while rendering slash values and keys with their scalar/key classes. An additional plain `go vet ./...` check reports the same existing unkeyed-composite diagnostics on master and this branch; the repository-configured lint passes. No Go source or dependency files are changed.
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.
This fixes a bug where comments that come after a name tag and contain a colon character are parsed as key-value pair instead of as comment.
For example, the following YAML is parsed as having the key
version: 2 # Required:Therefore, this makes the
NameTagregex stricter and doesn't allow the hash character in name tags, avoiding the bad parsing.Example
A current example of how this breaks in practice is our GitLab Caproni docs site, which uses imfing/hextra, which uses Chroma. The YAML comments are treated partially as keys instead of comments.