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

Rule: comment-style #807

Open
anderseknert opened this issue Jun 7, 2024 · 0 comments
Open

Rule: comment-style #807

anderseknert opened this issue Jun 7, 2024 · 0 comments

Comments

@anderseknert
Copy link
Member

Similar to how Go has ideas about what "doc comments" should look like (capitalized, sentence ending with period), it would be useful if Regal provided a way to enforce preferences on what metadata annotation values like title and description should look like. Since there's no established convention for that, we'll leave it up to the user to decide until there is one, and hence this rule should go in the custom category.

We should allow providing a regex that needs to match a given attribute, but perhaps also some pre-sets for the most common things like capitalization, periods, and whatnot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: TODO
Development

No branches or pull requests

1 participant