How terraform-linters/tflint-ruleset-terraform works
This repository is a TFLint plugin ruleset for Terraform: TFLint starts the plugin, which serves a ruleset of checks that inspect Terraform modules and report issues, sometimes with fixes. The rule families cover syntax and deprecated constructs, naming and module conventions, provider/version requirements, unused declarations, and module sources and workspaces. The README documents plugin use and the broad purpose; source excerpts show the plugin entry point and several rule implementations. Some internal dispatch details are not shown, so those links are marked unverified.
Main entry points: runner.go Terraform runner · main.go Plugin entry · ruleset.go Terraform ruleset · preset.go Rule presets
Components 17
Plugin runtime
- Plugin entry
main.go - Terraform ruleset
terraform/ruleset.go - Rule presets
rules/preset.go - Terraform runner
terraform/runner.go - Plugin configuration
terraform/config.go
Syntax and declarations
- Syntax checks
rules/terraform_json_syntax.go - Deprecated syntax
rules/terraform_deprecated_interpolation.go - Declaration checks
rules/terraform_unused_declarations.go - Documented variables and outputs
rules/terraform_documented.go
Module conventions
- Naming conventions
rules/terraform_naming_convention.go - Module structure
rules/terraform_standard_module_structure.go - Workspace backend check
rules/terraform_workspace_remote.go
Providers and modules
- Provider requirements
rules/terraform_required_providers.go - Module versions
rules/terraform_module_version.go - Pinned module sources
rules/terraform_module_pinned_source.go - Shallow cloning
rules/terraform_module_shallow_clone.go
Other components
- TFLint host
Connections 16
- TFLint host → Plugin entry: starts plugin
README.md - Plugin entry → Terraform ruleset: serves ruleset
main.go - Plugin entry → Rule presets: sets presets
main.go - Terraform ruleset → Terraform runner: dispatches checks
- Terraform runner → Plugin configuration: loads configuration
- Terraform runner → Syntax checks: runs checks
- Terraform runner → Deprecated syntax: runs checks
- Terraform runner → Declaration checks: runs checks
- Terraform runner → Documented variables and outputs: runs checks
- Terraform runner → Naming conventions: runs checks
- Terraform runner → Module structure: runs checks
- Terraform runner → Workspace backend check: runs checks
- Terraform runner → Provider requirements: runs checks
- Terraform runner → Module versions: runs checks
- Terraform runner → Pinned module sources: runs checks
- Terraform runner → Shallow cloning: runs checks