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

also search for .regal.yaml #1288

Open
grosser opened this issue Dec 4, 2024 · 1 comment
Open

also search for .regal.yaml #1288

grosser opened this issue Dec 4, 2024 · 1 comment

Comments

@grosser
Copy link

grosser commented Dec 4, 2024

as per https://docs.styra.com/regal#configuration regal looks for .regal/config.yaml
... but I don't really want a whole folder for just 1 file, and rather have another dot-file in the base of the repo as so many other tools do

@anderseknert
Copy link
Member

Hey, and thanks for the feedback!

I don't really have a strong preference on that, so looking for a .regal.yaml (or whatever we'd want the name to be?) in addition to .regal/config.yaml sounds reasonable to me. The reason we went with a directory is that it allows us to use it for more than configuration. Like how custom linter rules can be placed under .regal/rules and automatically be picked up by the linter. But most users probably don't have custom rules, so providing more options for where to put their configuration would be nice.

The --config-file flag can be used with regal lint for this today, but it's obviously not as ergonomic as a default location. And AFAIR, it doesn't work with the language server.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants