Rule: messy-rule

[anderseknert]

While working on support for document symbols, one of the open questions was how to best represent Rego's incremental rule definitions for a format that largely expects location ranges for identification. @charlieegan3 suggested a rule to enforce that incremental rules and function definitions are grouped together in a package. So something like this would be discouraged:

package p

allow if something

unrelated_rule if {
    # ...
}

allow if something_else

In favor of:

package p

allow if something

allow if something_else

unrelated_rule if {
    # ...
}

Looking at the Regal code base, we're violating this frequently ourselves 😅 And since it "doesn't matter" it's easy to forget about without tooling to help enforce this. Needless to say, this would be a style category rule, or possibly even custom if we think this should be optional. But as the document symbols feature showed us, even style can have a real-world impact.