https://github.com/terraform-linters/tflint-ruleset-terraform

TFLint ruleset for Terraform Language
https://github.com/terraform-linters/tflint-ruleset-terraform

terraform tflint tflint-ruleset

Last synced: 3 days ago
JSON representation

TFLint ruleset for Terraform Language

• Host: GitHub
• URL: https://github.com/terraform-linters/tflint-ruleset-terraform
• Owner: terraform-linters
• License: mpl-2.0
• Created: 2022-07-31T06:37:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-03T13:20:53.000Z (10 days ago)
• Last Synced: 2024-11-03T14:22:58.450Z (10 days ago)
• Topics: terraform, tflint, tflint-ruleset
• Language: Go
• Homepage:
• Size: 387 KB
• Stars: 64
• Watchers: 4
• Forks: 23
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TFLint Ruleset for Terraform Language

[![Build Status](https://github.com/terraform-linters/tflint-ruleset-terraform/workflows/build/badge.svg?branch=main)](https://github.com/terraform-linters/tflint-ruleset-terraform/actions)

[![GitHub release](https://img.shields.io/github/release/terraform-linters/tflint-ruleset-terraform.svg)](https://github.com/terraform-linters/tflint-ruleset-terraform/releases/latest)

[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-blue.svg)](LICENSE)

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`:

```hcl

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](docs/configuration.md).

## Rules

See [Rules](docs/rules/README.md).

## 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`:

```hcl

plugin "terraform" {

    enabled = true

}

```