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

TFLint ruleset for terraform-provider-azurerm
https://github.com/terraform-linters/tflint-ruleset-azurerm

azure azure-resource-manager terraform tflint tflint-ruleset

Last synced: about 16 hours ago
JSON representation

TFLint ruleset for terraform-provider-azurerm

• Host: GitHub
• URL: https://github.com/terraform-linters/tflint-ruleset-azurerm
• Owner: terraform-linters
• License: mpl-2.0
• Created: 2020-03-08T06:41:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T01:23:11.000Z (18 days ago)
• Last Synced: 2024-10-24T11:44:53.668Z (17 days ago)
• Topics: azure, azure-resource-manager, terraform, tflint, tflint-ruleset
• Language: Go
• Homepage:
• Size: 2.09 MB
• Stars: 119
• Watchers: 5
• Forks: 25
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - terraform-linters/tflint-ruleset-azurerm - TFLint ruleset for terraform-provider-azurerm (Go)

README

        
# TFLint Ruleset for terraform-provider-azurerm

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

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

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

TFLint ruleset plugin for Terraform Provider for Azure (Resource Manager)

## Requirements

- TFLint v0.42+

- Go v1.22

## Installation

You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:

```hcl

plugin "azurerm" {

    enabled = true

    version = "0.27.0"

    source  = "github.com/terraform-linters/tflint-ruleset-azurerm"

}

```

## Rules

200+ rules are available. See the [documentation](docs/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 "azurerm" {

    enabled = true

}

```

## Add a new rule

If you are interested in adding a new rule to this ruleset, you can use the generator. Run the following command:

```

$ go run ./rules/generator

```

Follow the instructions to edit the generated files and open a new pull request.