Revise rules documentation #158
Merged
+19
−17
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
wata727
commented
Feb 18, 2024
| @@ -33,7 +33,7 @@ Reference: https://github.com/terraform-linters/tflint-ruleset-terraform/blob/v0 | |||
|
|
|||
| Terraform v0.12 introduces a new interpolation syntax, but continues to support the old 0.11-style interpolation syntax for compatibility. | |||
|
|
|||
| Terraform will currently print diagnostic warnings when deprecated interpolations are used. Consistent with its deprecation policy, they will raise errors in the next major release (v0.13). TFLint emits an issue instead of a warning with the same logic. | |||
| `terraform fmt` can replace this redundant interpolation, so although it is not deprecated in the latest Terraform version, this rule allows you to issue a warning similar to Terraform v0.12.14. | |||
There was a problem hiding this comment.
The deprecation warning ended up not being an error and was removed in v0.15 hashicorp/terraform#27835
wata727
commented
Feb 18, 2024
| Naming conventions are optional, so it is not necessary to follow this. | ||
| But this rule is useful if you want to force the following naming conventions in line with the [Terraform Plugin Naming Best Practices](https://www.terraform.io/docs/extend/best-practices/naming.html). | ||
| Naming conventions are optional, so you don't necessarily have to follow them. | ||
| However, if your team owns Terraform configurations, it can be helpful to have a consistent naming convention. |
There was a problem hiding this comment.
The linked documentation doesn't specifically mention naming conventions for label names, so deleted it.
wata727
commented
Feb 18, 2024
| @@ -2,6 +2,8 @@ | |||
|
|
|||
| Check that all `required_providers` are used in the module. | |||
|
|
|||
| Note: Because TFLint cannot traverse the complete module tree, it may issue warnings for `required_providers` declared to specify constraints on the provider versions used by a module. If this false positive is unacceptable, you can disable the rule. See also https://github.com/terraform-linters/tflint-ruleset-terraform/issues/21. | |||
There was a problem hiding this comment.
It mentions the technical limitations that pose a problem in enabling this rule.
bendrucker
approved these changes
Feb 18, 2024
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 revises some rules documents that are not current.