Allow comments in chromatic.config.json
#1114
Assignees
Labels
CLI
Empathy
enhancement
Classification: New feature or request
released
Verdict: This issue/pull request has been released
Comments
jwir3
added a commit
that referenced
this issue
Nov 5, 2024
This adds support for JSON5 as a configuration file language, allowing for an extension to JSON that supports comments and other features. Fixes CAP-2357. Fixes #1114.
jwir3
added
enhancement
jwir3
added a commit
that referenced
this issue
Nov 6, 2024
This adds support for JSON5 as a configuration file language, allowing for an extension to JSON that supports comments and other features. Fixes CAP-2357. Fixes #1114.
jwir3
added a commit
that referenced
this issue
Nov 7, 2024
This adds support for JSON5 as a configuration file language, allowing for an extension to JSON that supports comments and other features. Fixes CAP-2357. Fixes #1114.
jwir3
added a commit
that referenced
this issue
Nov 7, 2024
This adds support for JSON5 as a configuration file language, allowing for an extension to JSON that supports comments and other features. Fixes CAP-2357. Fixes #1114.
jwir3
added a commit
that referenced
this issue
Nov 7, 2024
This adds support for JSON5 as a configuration file language, allowing for an extension to JSON that supports comments and other features. Fixes CAP-2357. Fixes #1114.
|
🚀 Issue was released in |
chromatic-ci-bot
added
the
released
|
🚀 Issue was released in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Feature request
I'd like to be able to write comments in my Chromatic configuration file so that other developers on my team can understand why I configured it the way I did.
Proposed solution
Parse the configuration file with something like JSON5.
Consider supporting both
chromatic.config.jsonandchromatic.config.jsonc(the file extension is important for editor support).Alternative solutions
I considered using a non-standard config file path with a
.jsoncextension, which would at least make my editor allow comments in the file, but the Chromatic CLI would still crash.I guess I could strip comments from the file in CI, then pass the processed file to Chromatic... but that means I can't easily run the Chromatic CLI locally.
Additional context
chromatic.config.jsonis parsed withJSON.parse, which will throw an error if there are comments in the JSON.The text was updated successfully, but these errors were encountered: