Repository navigation
Support comments in config files #1125
Description
Problem
changesets uses JSON for its config file format. Unfortunately JSON doesn't support comments which makes it hard to document the configuration. This is especially important in a larger team where few developers change the config very often. We can document things in the readme, but our experience is that inline comments are a better solution.
Proposed solution
One option would be to use a JSON with comments parser. Another might be to use something like cosmiconfig to support a bunch of formats including JavaScript itself.
Reacted by yonran
Activity
cdaringe commentedon Sep 8, 2023
i want the format in JS, as my
linkedpackages need to be looked up automatically, as a different entity controls this contraint. would be great to produce my linked packages, ...which then allows comments intrinsically :)bluwy commentedon Oct 6, 2024
Related: #1089
beeequeue commentedon Jun 9, 2026
supporting json5 or jsonc requires new dependencies we don't want in the project
closing in favor of #1089 (JS/TS config support, which allows comments)