generated from terraform-linters/tflint-ruleset-template
-
Notifications
You must be signed in to change notification settings - Fork 31
add terraform_json_syntax rule #297
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
Merged
Merged
Conversation
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
Adds a new rule to enforce Terraform's documented JSON syntax (object at root) over HCL's also-valid array syntax. While HCL supports array syntax at the root, Terraform documentation specifies using a JSON object. This rule warns users when they use array syntax, helping them follow Terraform's standard. - Enabled by default (warning severity) - Included in 'all' and 'recommended' presets - Comprehensive tests and documentation
3 tasks
wata727
reviewed
Oct 16, 2025
- Refactor canMergeValues to use cleaner recursive pattern - Simplify merge decision logic in the fixer - Maintain all existing behavior while improving code clarity
Member
Author
|
Trimmed the error and added autofix. It's a lot of code compared to just handling detection, but it's also a major annoyance/confusion to eliminate for users. |
wata727
approved these changes
Oct 17, 2025
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.
Adds a new rule to enforce Terraform's official JSON syntax, which requires a root object rather than an array. HCL supports both syntaxes:
https://github.com/hashicorp/hcl/blob/main/json/spec.md
Terraform's documentation specifies that JSON configurations should use a root object with keys for each block type (
resource,variable,output, etc.). It inherits HCL's support for arrays and flattening them, but it never documents this.Changes
terraform_json_syntaxrule that detects array syntax at the root of.tf.jsonfiles.encoding/jsonto unmarshal and check the root type structure.Testing
References
WalkExpressions