generated from terraform-linters/tflint-ruleset-template
-
Notifications
You must be signed in to change notification settings - Fork 5
Add support for multiple policy directories #187
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
Open
edubxb
wants to merge
3
commits into
terraform-linters:main
Choose a base branch
from
edubxb:support-many-policy-dirs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,52 @@ | ||
| # Configuration | ||
|
|
||
| This plugin can take advantage of additional features by configure the plugin block. Currently, this configuration is only available for customizing a policy directory. | ||
| This plugin can take advantage of additional features by configure the plugin block. Currently, this configuration is only available for customizing the directories to load policies. | ||
|
|
||
| Here's an example: | ||
|
|
||
| ```hcl | ||
| plugin "opa" { | ||
| // Plugin common attributes | ||
|
|
||
| policy_dir = "./policies" | ||
| policy_dirs = ["./policies", "./other-policies"] | ||
| } | ||
| ``` | ||
|
|
||
| ## `policy_dir` | ||
| ## `policy_dirs` | ||
|
|
||
| Default: `./.tflint.d/policies`, `~/.tflint.d/policies` | ||
|
|
||
| Change the directory from which policies are loaded. The priority is as follows: | ||
| Change the directories from which policies are loaded. You can specify multiple directories to load policies from different locations. The priority is as follows: | ||
|
|
||
| 1. `policy_dir` in the config | ||
| 2. `TFLINT_OPA_POLICY_DIR` environment variable | ||
| 1. `policy_dirs` in the config | ||
| 2. `TFLINT_OPA_POLICY_DIRS` environment variable (supports multiple directories separated `,`) | ||
| 3. `./.tflint.d/policies` | ||
| 4. `~/.tflint.d/policies` | ||
|
|
||
| A relative path is resolved from the current directory. | ||
|
|
||
| ### Examples | ||
|
|
||
| Single directory: | ||
| ```hcl | ||
| plugin "opa" { | ||
| policy_dirs = ["./policies"] | ||
| } | ||
| ``` | ||
|
|
||
| Multiple directories: | ||
| ```hcl | ||
| plugin "opa" { | ||
| policy_dirs = ["./policies", "./team-policies", "~/shared-policies"] | ||
| } | ||
| ``` | ||
|
|
||
| Using environment variable with a single directory: | ||
| ```bash | ||
| export TFLINT_OPA_POLICY_DIRS="./policies" | ||
| ``` | ||
|
|
||
| Using environment variable with multiple directories: | ||
| ```bash | ||
| export TFLINT_OPA_POLICY_DIRS="./policies,./team-policies,~/shared-policies" | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid unnecessary length checks before loops. You can just declare
var dirs []stringin the function scope.range c.PolicyDirs, appending in the loop, and thenif len(dirs)after that, return.Same thing for env.
Just range over that, if the env is
"", you're ranging over an empty slice. And again returndirsiflen(dirs) > 0after that loop too.