Update configdoc to support more shapes of TOML - #2381
Open
nolag wants to merge 1 commit into
Open
Conversation
Contributor
|
👋 nolag, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
Contributor
📊 API Diff Results
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved review findings affect TOML parsing, validation, and array-of-tables default handling.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates configdoc to support more TOML shapes, including indentation, nested/map tables, arrays, and generated preambles.
Changes:
- Normalizes indented TOML lines and table names.
- Adds dynamic map-key and generated-preamble handling.
- Expands parser and defaults tests.
File summaries
| File | Summary |
|---|---|
pkg/config/configdoc/defaults.go |
Updates indented default extraction. Moderate (line 44): example array headers are skipped before array handling. Critical (line 49): blank-line skipping can consume subsequent tables. |
pkg/config/configdoc/defaults_test.go |
Adds coverage for nested, map, and array defaults. |
pkg/config/configdoc/configdoc.go |
Extends TOML documentation parsing. Moderate (line 49): generated-comment detection is too broad. Moderate (line 147): key parsing does not handle valid TOML separators. Moderate (line 218): table descriptions can incorrectly satisfy undocumented fields. |
pkg/config/configdoc/configdoc_test.go |
Adds parser and generation coverage. |
Review details
Files not reviewed (1)
- pkg/config/configdoc/defaults_test.go: Generated file
Suppressed comments (2)
pkg/config/configdoc/configdoc.go:49
- This check is broader than a generated-file banner: any standalone comment block whose first line merely contains
generatedis dropped at the next blank line. A legitimate note such asThis value is generated at runtimecan therefore disappear from the generated documentation. Match the canonical preamble markers (for example,generatedtogether withDO NOT EDIT) instead of the substring alone.
return len(desc) > 0 && strings.Contains(strings.ToLower(desc[0]), "generated")
pkg/config/configdoc/defaults.go:48
- When an array-of-tables header carries the
# Examplemarker, thiscontinueruns before the[[...]]branch below, soskipUntilis never set. Any default-marked field inside that array is then emitted to the decoder at the wrong level instead of being ignored, which can cause strict decoding to fail. Detect[[before skipping example lines so the whole array is discarded.
if strings.HasPrefix(trimmed, "#") || strings.HasSuffix(trimmed, FieldExample) {
continue
}
// Skip arrays of tables
- Files reviewed: 3/4 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+49
to
51
| if strings.HasPrefix(trimmed, "[[") { | ||
| // skip fields until next empty line | ||
| skipUntil = func(line string) bool { return strings.TrimSpace(line) == "" } |
Comment on lines
+147
to
+149
| if i := strings.Index(line, " "); i > -1 { | ||
| name = line[:i] | ||
| } |
Comment on lines
+218
to
+220
| if len(desc) == 0 && currentTable != &globalTable && len(currentTable.desc) > 0 { | ||
| desc = currentTable.desc | ||
| inherited = true |
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.
No description provided.