Add a suggestion to match the package name and file location #35
Conversation
Signed-off-by: Charlie Egan <[email protected]>
Signed-off-by: Charlie Egan <[email protected]>
charlieegan3
force-pushed
the
dir-structure
branch
from
2762a21
to
68847ec
Compare
charlieegan3
force-pushed
the
dir-structure
branch
from
68847ec
to
fbf4539
Compare
style-guide.md
Outdated
| @@ -51,6 +51,8 @@ Rego policies. If you enjoy this style guide, make sure to check it out! | |||
| * [Avoid using the last argument for the return value](#avoid-using-the-last-argument-for-the-return-value) | |||
| * [Regex](#regex) | |||
| * [Use raw strings for regex patterns](#use-raw-strings-for-regex-patterns) | |||
| * [Packages](#packages) | |||
| * [Package name should make file location](#package-name-should-make-file-location) | |||
style-guide.md
Outdated
| @@ -200,11 +206,13 @@ developer experience as well as the quality of your policies. | |||
| The built-in functions use `snake_case` for naming — follow that convention for your own rules, functions, and variables. | |||
|
|
|||
| **Avoid** | |||
|
|
|||
There was a problem hiding this comment.
I disabled this rule in the Regal repo, as IMHO, it just makes the code blocks feel detached... but I don't feel strongly about it. Fine to change here.
There was a problem hiding this comment.
Reverted in a620cb3
|
|
||
| ```rego | ||
| # foo/bar.rego | ||
| package bar.foo |
There was a problem hiding this comment.
There's been some discussion between me and @srenatus about this yesterday, and there's basically two ideas here (not necessarily represented by any of us 😆):
-
Only directory structure (and not filename) should mirror the package path. Otherwise, you'd be forced to have all your code for any given package kept in a single file, which isn't ideal. See for example the number of files contributing to
regal.ast. I kinda like this idea, but one unresolved issue with it is how to deal with tests. Surely we don't want to recommend using afoo/bar_testdirectory forfoo.bar_test? So if we go with this option, I think tests should only need to match up their package path with the directory structure up until_test. -
Directory structure and filename should contribute to the package path. This is basically how the
bundle/regal/rulesdirectory works looks right now, and since there's always only one file per rule (+ test), this has worked well. But while we don't have the problem of multiple files contributing to a single package, it's hard to make that a general recommendation.
Since this is the Rego Style Guide and not Regal, perhaps we can simply describe both of these approaches with their pros and cons, and then settle for one default in Regal, but allow configuration toggles for flexibility.
I think that what matters most is not how exactly, but that this is done consistently across a project.
There was a problem hiding this comment.
I've added an updated version in 9b7f0f5
4c7c854 is the new content.