github.com/terraform-linters/tflint-ruleset-azurerm@v0.26.0/README.md (about)

     1  # TFLint Ruleset for terraform-provider-azurerm
     2  [![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)
     3  [![GitHub release](https://img.shields.io/github/release/terraform-linters/tflint-ruleset-azurerm.svg)](https://github.com/terraform-linters/tflint-ruleset-azurerm/releases/latest)
     4  [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-blue.svg)](LICENSE)
     5  
     6  TFLint ruleset plugin for Terraform Provider for Azure (Resource Manager)
     7  
     8  ## Requirements
     9  
    10  - TFLint v0.42+
    11  - Go v1.22
    12  
    13  ## Installation
    14  
    15  You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:
    16  
    17  ```hcl
    18  plugin "azurerm" {
    19      enabled = true
    20      version = "0.26.0"
    21      source  = "github.com/terraform-linters/tflint-ruleset-azurerm"
    22  }
    23  ```
    24  
    25  ## Rules
    26  
    27  200+ rules are available. See the [documentation](docs/README.md).
    28  
    29  ## Building the plugin
    30  
    31  Clone the repository locally and run the following command:
    32  
    33  ```
    34  $ make
    35  ```
    36  
    37  You can easily install the built plugin with the following:
    38  
    39  ```
    40  $ make install
    41  ```
    42  
    43  Note that if you install the plugin with make install, you must omit the `version` and `source` attributes in `.tflint.hcl`:
    44  
    45  ```hcl
    46  plugin "azurerm" {
    47      enabled = true
    48  }
    49  ```
    50  
    51  ## Add a new rule
    52  
    53  If you are interested in adding a new rule to this ruleset, you can use the generator. Run the following command:
    54  
    55  ```
    56  $ go run ./rules/generator
    57  ```
    58  
    59  Follow the instructions to edit the generated files and open a new pull request.