pre-commit-opentofu/README.md

21 lines
1.3 KiB
Markdown
Raw Normal View History

2016-09-27 20:01:11 +02:00
# pre-commit-terraform hook
2016-09-27 19:47:26 +02:00
2018-01-15 16:27:01 +01:00
[![Github tag](https://img.shields.io/github/tag/antonbabenko/pre-commit-terraform.svg)](https://github.com/antonbabenko/pre-commit-terraform/releases) ![](https://img.shields.io/maintenance/yes/2018.svg) [![Help Contribute to Open Source](https://www.codetriage.com/antonbabenko/pre-commit-terraform/badges/users.svg)](https://www.codetriage.com/antonbabenko/pre-commit-terraform)
Several [pre-commit](http://pre-commit.com/) hooks to keep Terraform configurations (both `*.tf` and `*.tfvars`) in a good shape:
* `terraform_fmt` - Rewrites all Terraform configuration files to a canonical format.
* `terraform_validate_no_variables` - Validates all Terraform configuration files without checking whether all required variables were set.
2018-01-24 15:46:37 +01:00
* `terraform_validate_with_variables` - Validates all Terraform configuration files and checks whether all required variables were specified.
Note that `terraform_validate_no_variables` and `terraform_validate_with_variables` will not work if variables are being set dynamically (eg, when using [Terragrunt](https://github.com/gruntwork-io/terragrunt)). Use `terragrunt validate` command instead.
2016-09-27 19:47:26 +02:00
An example `.pre-commit-config.yaml`:
```yaml
- repo: git://github.com/antonbabenko/pre-commit-terraform
2018-03-06 13:59:22 +01:00
sha: v1.5.0
hooks:
- id: terraform_fmt
2016-09-27 19:47:26 +02:00
```
2016-09-27 20:01:11 +02:00
Enjoy the clean code!