]> git.madduck.net Git - etc/vim.git/blobdiff - .vim/bundle/ale/doc/ale-terraform.txt

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'
[etc/vim.git] / .vim / bundle / ale / doc / ale-terraform.txt
diff --git a/.vim/bundle/ale/doc/ale-terraform.txt b/.vim/bundle/ale/doc/ale-terraform.txt
new file mode 100644 (file)
index 0000000..ae8a7bc
--- /dev/null
@@ -0,0 +1,167 @@
+===============================================================================
+ALE Terraform Integration                               *ale-terraform-options*
+
+
+===============================================================================
+checkov                                                 *ale-terraform-checkov*
+
+                                     *ale-options.terraform_checkov_executable*
+                                           *g:ale_terraform_checkov_executable*
+                                           *b:ale_terraform_checkov_executable*
+terraform_checkov_executable
+g:ale_terraform_checkov_executable
+  Type: |String|
+  Default: `'checkov'`
+
+  This variable can be changed to use a different executable for checkov.
+
+                                        *ale-options.terraform_checkov_options*
+                                              *g:ale_terraform_checkov_options*
+                                              *b:ale_terraform_checkov_options*
+terraform_checkov_options
+g:ale_terraform_checkov_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to set additional options for checkov.
+
+
+===============================================================================
+terraform-fmt-fixer                                   *ale-terraform-fmt-fixer*
+
+                                         *ale-options.terraform_fmt_executable*
+                                               *g:ale_terraform_fmt_executable*
+                                               *b:ale_terraform_fmt_executable*
+terraform_fmt_executable
+g:ale_terraform_fmt_executable
+  Type: |String|
+  Default: `'terraform'`
+
+  This variable can be changed to use a different executable for terraform.
+
+                                            *ale-options.terraform_fmt_options*
+                                                  *g:ale_terraform_fmt_options*
+                                                  *b:ale_terraform_fmt_options*
+terraform_fmt_options
+g:ale_terraform_fmt_options
+  Type: |String|
+  Default: `''`
+
+
+===============================================================================
+terraform                                             *ale-terraform-terraform*
+
+                                   *ale-options.terraform_terraform_executable*
+                                         *g:ale_terraform_terraform_executable*
+                                         *b:ale_terraform_terraform_executable*
+terraform_terraform_executable
+g:ale_terraform_terraform_executable
+  Type: |String|
+  Default: `'terraform'`
+
+  This variable can be changed to use a different executable for terraform.
+
+
+===============================================================================
+terraform-ls                                       *ale-terraform-terraform-ls*
+
+Official terraform language server. More stable than *terraform-lsp* but
+currently has less features.
+
+                                          *ale-options.terraform_ls_executable*
+                                                *g:ale_terraform_ls_executable*
+                                                *b:ale_terraform_ls_executable*
+terraform_ls_executable
+g:ale_terraform_ls_executable
+  Type: |String|
+  Default: `'terraform-ls'`
+
+  This variable can be changed to use a different executable for terraform-ls.
+
+                                             *ale-options.terraform_ls_options*
+                                                   *g:ale_terraform_ls_options*
+                                                   *b:ale_terraform_ls_options*
+terraform_ls_options
+g:ale_terraform_ls_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to pass custom CLI flags to terraform-ls.
+
+
+===============================================================================
+terraform-lsp                                     *ale-terraform-terraform-lsp*
+
+                                  *ale-options.terraform_langserver_executable*
+                                        *g:ale_terraform_langserver_executable*
+                                        *b:ale_terraform_langserver_executable*
+terraform_langserver_executable
+g:ale_terraform_langserver_executable
+  Type: |String|
+  Default: `'terraform-lsp'`
+
+  This variable can be changed to use a different executable for terraform-lsp.
+
+                                     *ale-options.terraform_langserver_options*
+                                           *g:ale_terraform_langserver_options*
+                                           *b:ale_terraform_langserver_options*
+terraform_langserver_options
+g:ale_terraform_langserver_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to pass custom CLI flags to terraform-lsp.
+
+
+===============================================================================
+tflint                                                   *ale-terraform-tflint*
+
+                                      *ale-options.terraform_tflint_executable*
+                                            *g:ale_terraform_tflint_executable*
+                                            *b:ale_terraform_tflint_executable*
+terraform_tflint_executable
+g:ale_terraform_tflint_executable
+  Type: |String|
+  Default: `'tflint'`
+
+  This variable can be changed to use a different executable for tflint.
+
+                                         *ale-options.terraform_tflint_options*
+                                               *g:ale_terraform_tflint_options*
+                                               *b:ale_terraform_tflint_options*
+terraform_tflint_options
+g:ale_terraform_tflint_options
+  Type: |String|
+  Default: `'-f json'`
+
+  This variable can be changed to pass different options to tflint. Ale does
+  expect json output from tflint, so if you change this, you'll probably want
+  to include '-f json' in your new value.
+
+
+===============================================================================
+tfsec                                                     *ale-terraform-tfsec*
+
+                                       *ale-options.terraform_tfsec_executable*
+                                             *g:ale_terraform_tfsec_executable*
+                                             *b:ale_terraform_tfsec_executable*
+terraform_tfsec_executable
+g:ale_terraform_tfsec_executable
+  Type: |String|
+  Default: `'tfsec'`
+
+  This variable can be changed to use a different executable for tfsec.
+
+                                          *ale-options.terraform_tfsec_options*
+                                                *g:ale_terraform_tfsec_options*
+                                                *b:ale_terraform_tfsec_options*
+terraform_tfsec_options
+g:ale_terraform_tfsec_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to pass custom CLI flags to tfsec.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: