gh-dash icon indicating copy to clipboard operation
gh-dash copied to clipboard

Add JSON Schema for config

Open michaeltlombardi opened this issue 1 year ago • 0 comments

Is your feature request related to a problem? Please describe.

When I'm editing the config, I need to keep the docs open and constantly refer back and forth while I make changes, both to see what keys are available and how to write a valid value.

Describe the solution you'd like

With a JSON Schema for the config file, I could tell my editor what schema to use and then get auto-completion, validation, and documentation for the settings in the same context, reducing my cognitive load and making it easier to author and update my configuration(s).

Describe alternatives you've considered

I could write my own standalone schema file and keep it locally, but that wouldn't benefit the community and would likely drift from accuracy with each release.

Additional context

N/A

michaeltlombardi avatar Sep 01 '22 16:09 michaeltlombardi