mirror of
https://github.com/tofuutils/pre-commit-opentofu.git
synced 2025-10-15 17:38:54 +02:00
20 lines
1.3 KiB
Markdown
20 lines
1.3 KiB
Markdown
# pre-commit-terraform hook
|
|
|
|
[](https://github.com/antonbabenko/pre-commit-terraform/releases)  [](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.
|
|
* `terraform_validate_with_variables` - Validates all Terraform configuration files and checks whether all required variables were specified. This is an optional check, because it will not work if variables are being set dynamically (eg, when using [Terragrunt](https://github.com/gruntwork-io/terragrunt)). Use `terraform_validate_no_variables` hook instead.
|
|
|
|
An example `.pre-commit-config.yaml`:
|
|
|
|
```yaml
|
|
- repo: git://github.com/antonbabenko/pre-commit-terraform
|
|
sha: v1.4.0
|
|
hooks:
|
|
- id: terraform_validate_no_variables
|
|
- id: terraform_fmt
|
|
```
|
|
|
|
Enjoy the clean code!
|