Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create and publish .regal/config.yaml schema to JSON schema store #1006

Open
anderseknert opened this issue Aug 26, 2024 · 0 comments
Open
Labels

Comments

@anderseknert
Copy link
Member

We should create a JSON schema for the Regal configuration file format and have it published to the JSON schema store. This allows tools like the YAML language server (which is used by editors like VS Code and Zed) to automatically provide auto-completions and corrections based on the schema when the filename matches .regal/config.yaml.

Note that we should avoid having the schema auto-generated from Go structs, as both categories and rule names are dynamic. I'd suggest we use properties for all known categories and rule names, likely generated from the default config. We could provide one strict version, where only these names are allowed (to help identify typos), and one version where additional properties are allowed, for those who might have custom rules.

@StyraInc StyraInc deleted a comment Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants
@anderseknert and others