Skip to content

Support comments in config files #1125

@tylerbutler

Description

@tylerbutler

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions