use getopt for args in the tflint hook, following the approach in ter…

…raform-docs (#75)
antonbabenko · Nov 16, 2019 · 8bddc8b · 8bddc8b
1 parent cbf2458
commit 8bddc8b
Show file tree

Hide file tree

Showing 3 changed files with 537 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,7 @@
 <a name="unreleased"></a>
 ## [Unreleased]
 
-
+- Changes TFLint hook to not use --deep by default but allow enabling it (along with other parameters) via `args` ([#71](https://github.com/antonbabenko/pre-commit-terraform/issues/71))
 
 <a name="v1.20.0"></a>
 ## [v1.20.0] - 2019-11-02

diff --git a/README.md b/README.md
@@ -96,6 +96,17 @@ if they are present in `README.md`.
 
 1. `terraform-docs` works with Terraform 0.12 but support is hackish (it requires `awk` to be installed) and may contain bugs. You can follow the native support of Terraform 0.12 in `terraform-docs` in [issue #62](https://github.com/segmentio/terraform-docs/issues/62).
 
+## Notes about terraform_tflint hooks
+
+1. `terraform_tflint` supports custom arguments so you can enable module inspection, deep check mode etc.
+
+    1. Example:
+    ```yaml
+    hooks:
+      - id: terraform_tflint
+        args: ['--deep']
+    ```
+
 ## Notes for developers
 
 1. Python hooks are supported now too. All you have to do is: