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

Ignore long URLs in metadata for line-length rule #1329

Open
nikpivkin opened this issue Jan 10, 2025 · 2 comments
Open

Ignore long URLs in metadata for line-length rule #1329

nikpivkin opened this issue Jan 10, 2025 · 2 comments

Comments

@nikpivkin
Copy link

Hi!

In the metadata of our Rego files, long links are triggering the line-length rule:

Rule:           line-length                                                                                                             
Description:    Line too long                                                                                                           
Category:       style                                                                                                                   
Location:       checks/cloud/aws/msk/enable_at_rest_encryption.rego:26:1                                                                
Text:           #       - https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/msk_cluster#encryption_info-arg...
Documentation:  https://docs.styra.com/regal/rules/style/line-length  

I don't want to disable this rule, what are some workarounds? Should rules ignore policy metadata?

@anderseknert
Copy link
Member

Hi there! The non-breakable-word-threshold option should help you with that. Let me know if that doesn't work.

https://docs.styra.com/regal/rules/style/line-length#configuration-options

@anderseknert
Copy link
Member

Did that help? :)

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