-
Notifications
You must be signed in to change notification settings - Fork 349
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
Add terraform_standard_module_structure rule #801
Merged
bendrucker
merged 6 commits into
terraform-linters:master
from
bendrucker:tf-standard-module-structure
Jun 18, 2020
Merged
Add terraform_standard_module_structure rule #801
bendrucker
merged 6 commits into
terraform-linters:master
from
bendrucker:tf-standard-module-structure
Jun 18, 2020
Conversation
This file contains 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
dc50da6
to
ea103d3
Compare
The standard module structure also enforces that a readme exist within the module ( |
de9b46a
to
f793e61
Compare
I did think about that but chose to skip it:
|
Other related ideas here:
|
wata727
approved these changes
Jun 18, 2020
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.
👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR creates a rule that enforces the Terraform standard module structure:
https://www.terraform.io/docs/modules/index.html#standard-module-structure
The rule itself ensures that main, variables, and outputs file are created. It also ensures that variable/output blocks are included in the corresponding file. File checks are skipped for JSON-only projects and block checks are skipped when the declaration was in a JSON file.
Outside of the rule implementation, I've also added logic to
TestRunnerWithConfig
that detects the directory so that rules can test configuration that is in a directory other than.
.