feat(config): support comments in JSON configuration files#22
Open
sunteya wants to merge 1 commit intovtemian:mainfrom
Open
feat(config): support comments in JSON configuration files#22sunteya wants to merge 1 commit intovtemian:mainfrom
sunteya wants to merge 1 commit intovtemian:mainfrom
Conversation
There was a problem hiding this comment.
1 issue found across 4 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="src/config-loader.ts">
<violation number="1" location="src/config-loader.ts:34">
P2: Jsonc.parse is fault-tolerant and won’t throw on invalid JSON; without checking its errors list, malformed or empty/comment-only configs can bypass the try/catch and be treated as valid, changing the error-handling semantics from returning null to returning undefined/partial configs.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| const configPath = join(baseDir, "opencode.json"); | ||
| const content = readFileSync(configPath, "utf-8"); | ||
| return JSON.parse(content) as OpencodeConfig; | ||
| return Jsonc.parse(content) as OpencodeConfig; |
There was a problem hiding this comment.
P2: Jsonc.parse is fault-tolerant and won’t throw on invalid JSON; without checking its errors list, malformed or empty/comment-only configs can bypass the try/catch and be treated as valid, changing the error-handling semantics from returning null to returning undefined/partial configs.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At src/config-loader.ts, line 34:
<comment>Jsonc.parse is fault-tolerant and won’t throw on invalid JSON; without checking its errors list, malformed or empty/comment-only configs can bypass the try/catch and be treated as valid, changing the error-handling semantics from returning null to returning undefined/partial configs.</comment>
<file context>
@@ -30,7 +31,7 @@ function loadOpencodeConfig(configDir?: string): OpencodeConfig | null {
const configPath = join(baseDir, "opencode.json");
const content = readFileSync(configPath, "utf-8");
- return JSON.parse(content) as OpencodeConfig;
+ return Jsonc.parse(content) as OpencodeConfig;
} catch {
return null;
</file context>
Suggested change
| return Jsonc.parse(content) as OpencodeConfig; | |
| const errors: { error: number }[] = []; | |
| const parsed = Jsonc.parse(content, errors); | |
| if (errors.length > 0) { | |
| return null; | |
| } | |
| return parsed as OpencodeConfig; |
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.
Summary
Introduced jsonc-parser to replace the standard JSON.parse method, enabling support for comments in configuration files.
Motivation
Configuration files (such as opencode.json, micode.json, and fragments.json) often benefit from comments for documentation purposes or for temporarily disabling specific settings. The standard JSON parser does not support comments, which limits the usability of these config files.
Changes
Verification
Summary by cubic
Enable comments in JSON config files by switching parsing to jsonc-parser. Users can add inline comments in opencode.json, micode.json, and fragments.json without parse errors.
New Features
Dependencies
Written for commit fc08267. Summary will update on new commits.