]> git.madduck.net Git - etc/vim.git/blob - 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:

Squashed '.vim/bundle/ale/' content from commit 22185c4c
[etc/vim.git] / doc / ale-terraform.txt
1 ===============================================================================
2 ALE Terraform Integration                               *ale-terraform-options*
3
4
5 ===============================================================================
6 checkov                                                 *ale-terraform-checkov*
7
8                                      *ale-options.terraform_checkov_executable*
9                                            *g:ale_terraform_checkov_executable*
10                                            *b:ale_terraform_checkov_executable*
11 terraform_checkov_executable
12 g:ale_terraform_checkov_executable
13   Type: |String|
14   Default: `'checkov'`
15
16   This variable can be changed to use a different executable for checkov.
17
18                                         *ale-options.terraform_checkov_options*
19                                               *g:ale_terraform_checkov_options*
20                                               *b:ale_terraform_checkov_options*
21 terraform_checkov_options
22 g:ale_terraform_checkov_options
23   Type: |String|
24   Default: `''`
25
26   This variable can be changed to set additional options for checkov.
27
28
29 ===============================================================================
30 terraform-fmt-fixer                                   *ale-terraform-fmt-fixer*
31
32                                          *ale-options.terraform_fmt_executable*
33                                                *g:ale_terraform_fmt_executable*
34                                                *b:ale_terraform_fmt_executable*
35 terraform_fmt_executable
36 g:ale_terraform_fmt_executable
37   Type: |String|
38   Default: `'terraform'`
39
40   This variable can be changed to use a different executable for terraform.
41
42                                             *ale-options.terraform_fmt_options*
43                                                   *g:ale_terraform_fmt_options*
44                                                   *b:ale_terraform_fmt_options*
45 terraform_fmt_options
46 g:ale_terraform_fmt_options
47   Type: |String|
48   Default: `''`
49
50
51 ===============================================================================
52 terraform                                             *ale-terraform-terraform*
53
54                                    *ale-options.terraform_terraform_executable*
55                                          *g:ale_terraform_terraform_executable*
56                                          *b:ale_terraform_terraform_executable*
57 terraform_terraform_executable
58 g:ale_terraform_terraform_executable
59   Type: |String|
60   Default: `'terraform'`
61
62   This variable can be changed to use a different executable for terraform.
63
64
65 ===============================================================================
66 terraform-ls                                       *ale-terraform-terraform-ls*
67
68 Official terraform language server. More stable than *terraform-lsp* but
69 currently has less features.
70
71                                           *ale-options.terraform_ls_executable*
72                                                 *g:ale_terraform_ls_executable*
73                                                 *b:ale_terraform_ls_executable*
74 terraform_ls_executable
75 g:ale_terraform_ls_executable
76   Type: |String|
77   Default: `'terraform-ls'`
78
79   This variable can be changed to use a different executable for terraform-ls.
80
81                                              *ale-options.terraform_ls_options*
82                                                    *g:ale_terraform_ls_options*
83                                                    *b:ale_terraform_ls_options*
84 terraform_ls_options
85 g:ale_terraform_ls_options
86   Type: |String|
87   Default: `''`
88
89   This variable can be changed to pass custom CLI flags to terraform-ls.
90
91
92 ===============================================================================
93 terraform-lsp                                     *ale-terraform-terraform-lsp*
94
95                                   *ale-options.terraform_langserver_executable*
96                                         *g:ale_terraform_langserver_executable*
97                                         *b:ale_terraform_langserver_executable*
98 terraform_langserver_executable
99 g:ale_terraform_langserver_executable
100   Type: |String|
101   Default: `'terraform-lsp'`
102
103   This variable can be changed to use a different executable for terraform-lsp.
104
105                                      *ale-options.terraform_langserver_options*
106                                            *g:ale_terraform_langserver_options*
107                                            *b:ale_terraform_langserver_options*
108 terraform_langserver_options
109 g:ale_terraform_langserver_options
110   Type: |String|
111   Default: `''`
112
113   This variable can be changed to pass custom CLI flags to terraform-lsp.
114
115
116 ===============================================================================
117 tflint                                                   *ale-terraform-tflint*
118
119                                       *ale-options.terraform_tflint_executable*
120                                             *g:ale_terraform_tflint_executable*
121                                             *b:ale_terraform_tflint_executable*
122 terraform_tflint_executable
123 g:ale_terraform_tflint_executable
124   Type: |String|
125   Default: `'tflint'`
126
127   This variable can be changed to use a different executable for tflint.
128
129                                          *ale-options.terraform_tflint_options*
130                                                *g:ale_terraform_tflint_options*
131                                                *b:ale_terraform_tflint_options*
132 terraform_tflint_options
133 g:ale_terraform_tflint_options
134   Type: |String|
135   Default: `'-f json'`
136
137   This variable can be changed to pass different options to tflint. Ale does
138   expect json output from tflint, so if you change this, you'll probably want
139   to include '-f json' in your new value.
140
141
142 ===============================================================================
143 tfsec                                                     *ale-terraform-tfsec*
144
145                                        *ale-options.terraform_tfsec_executable*
146                                              *g:ale_terraform_tfsec_executable*
147                                              *b:ale_terraform_tfsec_executable*
148 terraform_tfsec_executable
149 g:ale_terraform_tfsec_executable
150   Type: |String|
151   Default: `'tfsec'`
152
153   This variable can be changed to use a different executable for tfsec.
154
155                                           *ale-options.terraform_tfsec_options*
156                                                 *g:ale_terraform_tfsec_options*
157                                                 *b:ale_terraform_tfsec_options*
158 terraform_tfsec_options
159 g:ale_terraform_tfsec_options
160   Type: |String|
161   Default: `''`
162
163   This variable can be changed to pass custom CLI flags to tfsec.
164
165
166 ===============================================================================
167   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: