Skip to content

Commit

Permalink
Update README for terraform_tflint and terraform_validate
Browse files Browse the repository at this point in the history
  • Loading branch information
robinbowes committed Jul 6, 2020
1 parent 83bbdbf commit cee19e8
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ if they are present in `README.md`.
```yaml
hooks:
- id: terraform_tflint
args: ['args=--deep']
args: ['--args=--deep']
```

In order to pass multiple args, try the following:
```yaml
- id: terraform_tflint
args:
- 'args=--deep'
- 'args=--enable-rule=terraform_documented_variables'
- '--args=--deep'
- '--args=--enable-rule=terraform_documented_variables'
```

## Notes about terraform_tfsec hooks
Expand All @@ -131,6 +131,41 @@ if they are present in `README.md`.
}
```

## Notes about terraform_validate hooks

1. `terraform_validate` supports custom arguments so you can pass supported no-color or json flags.

1. Example:
```yaml
hooks:
- id: terraform_validate
args: ['--args=-json']
```

In order to pass multiple args, try the following:
```yaml
- id: terraform_validate
args:
- '--args=-json'
- '--args=-no-color'
```
1. `terraform_validate` also supports custom environment variables passed to the pre-commit runtime

1. Example:
```yaml
hooks:
- id: terraform_validate
args: ['--envs=AWS_DEFAULT_REGION="us-west-2"']
```

In order to pass multiple args, try the following:
```yaml
- id: terraform_validate
args:
- '--envs=AWS_DEFAULT_REGION="us-west-2"'
- '--envs=AWS_ACCESS_KEY_ID="anaccesskey"'
- '--envs=AWS_SECRET_ACCESS_KEY="asecretkey"'
```

## Notes for developers

Expand Down

0 comments on commit cee19e8

Please sign in to comment.