Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.69 KB

README.md

File metadata and controls

61 lines (42 loc) · 1.69 KB

TFLint Ruleset for Terraform Language

Build Status GitHub release License: MPL 2.0

TFLint ruleset plugin for Terraform Language

This ruleset focus on possible errors and best practices about Terraform Language.

Requirements

  • TFLint v0.42+
  • Go v1.22

Installation

This ruleset is built into TFLint, so you usually don't need to worry about how to install it. You can check the built-in version with tflint -v:

$ tflint -v
TFLint version 0.52.0
+ ruleset.terraform (0.8.0-bundled)

If you want to use a version different from the built-in version, you can declare plugin in .tflint.hcl as follows and install it with tflint --init:

plugin "terraform" {
    enabled = true
    version = "0.10.0"
    source  = "github.com/terraform-linters/tflint-ruleset-terraform"
}

For more configuration about the plugin, see Plugin Configuration.

Rules

See Rules.

Building the plugin

Clone the repository locally and run the following command:

$ make

You can easily install the built plugin with the following:

$ make install

Note that if you install the plugin with make install, you must omit the version and source attributes in .tflint.hcl:

plugin "terraform" {
    enabled = true
}