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

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

google-cloud terraform tflint tflint-ruleset

Last synced: 3 days ago
JSON representation

TFLint ruleset for terraform-provider-google

• Host: GitHub
• URL: https://github.com/terraform-linters/tflint-ruleset-google
• Owner: terraform-linters
• License: mpl-2.0
• Created: 2020-03-08T06:39:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T14:07:26.000Z (4 months ago)
• Last Synced: 2024-07-24T15:23:57.161Z (4 months ago)
• Topics: google-cloud, terraform, tflint, tflint-ruleset
• Language: Go
• Homepage:
• Size: 717 KB
• Stars: 67
• Watchers: 5
• Forks: 20
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TFLint Ruleset for terraform-provider-google

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

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

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

TFLint ruleset plugin for Terraform Google Cloud Platform provider

## 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 "google" {

    enabled = true

    version = "0.30.0"

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

}

```

For more configuration about the plugin, see [Plugin Configuration](docs/configuration.md).

## Rules

100+ rules are available. See the [documentation](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 "google" {

    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.