summaryrefslogtreecommitdiff
path: root/doc/ale-terraform.txt
diff options
context:
space:
mode:
authorKeith Maxwell <keith.maxwell@gmail.com>2019-05-23 14:12:36 +0100
committerKeith Maxwell <keith.maxwell@gmail.com>2019-05-23 15:49:02 +0100
commit88fa0b9294c6e907e8e2e8bee2ca593dff91b473 (patch)
tree5e094c3c5b45f2137ce821a93a86a3a6653ded01 /doc/ale-terraform.txt
parent1a9b8a58c7e01f0926e51b39b7b37f932537cc0c (diff)
downloadale-88fa0b9294c6e907e8e2e8bee2ca593dff91b473.zip
Add a terraform linter
This linter uses the check functionality built into terraform. ALE already has a fixer using `terraform fmt` but this doesn't provide error messages. ALE already has a linter using `tflint` but this requires an extra application to be installed. For example this linter will give a warning that ! is an illegal character in the line below: variable "example" !{} This linter runs the buffer through the command below and parses the output: terraform fmt -no-color -check=true - This commit includes a basic implementation, documentation and tests. The only option is to control which executable is run. Tested with: $ terraform -version Terraform v0.11.13
Diffstat (limited to 'doc/ale-terraform.txt')
-rw-r--r--doc/ale-terraform.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/ale-terraform.txt b/doc/ale-terraform.txt
index 49a55028..387fd732 100644
--- a/doc/ale-terraform.txt
+++ b/doc/ale-terraform.txt
@@ -3,7 +3,7 @@ ALE Terraform Integration *ale-terraform-options*
===============================================================================
-fmt *ale-terraform-fmt*
+terraform-fmt-fixer *ale-terraform-fmt-fixer*
g:ale_terraform_fmt_executable *g:ale_terraform_fmt_executable*
*b:ale_terraform_fmt_executable*
@@ -21,6 +21,18 @@ g:ale_terraform_fmt_options *g:ale_terraform_fmt_options*
===============================================================================
+terraform *ale-terraform-terraform*
+
+g:ale_terraform_terraform_executable *g:ale_terraform_terraform_executable*
+ *b:ale_terraform_terraform_executable*
+
+ Type: |String|
+ Default: `'terraform'`
+
+ This variable can be changed to use a different executable for terraform.
+
+
+===============================================================================
tflint *ale-terraform-tflint*
g:ale_terraform_tflint_executable *g:ale_terraform_tflint_executable*