summaryrefslogtreecommitdiff
path: root/doc/ale-terraform.txt
blob: 11422e64d5f9529b8641514feab029d4069f7a03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
===============================================================================
ALE Terraform Integration                               *ale-terraform-options*


===============================================================================
checkov                                                 *ale-terraform-checkov*

g:ale_terraform_checkov_executable         *g:ale_terraform_checkov_executable*
                                           *b:ale_terraform_checkov_executable*

  Type: |String|
  Default: `'checkov'`

  This variable can be changed to use a different executable for checkov.


g:ale_terraform_checkov_options               *g:ale_terraform_checkov_options*
                                              *b: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*

g:ale_terraform_fmt_executable                 *g:ale_terraform_fmt_executable*
                                               *b:ale_terraform_fmt_executable*

  Type: |String|
  Default: `'terraform'`

  This variable can be changed to use a different executable for terraform.


g:ale_terraform_fmt_options                       *g:ale_terraform_fmt_options*
                                                  *b:ale_terraform_fmt_options*
  Type: |String|
  Default: `''`


===============================================================================
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.


===============================================================================
terraform-ls                                       *ale-terraform-terraform-ls*

Official terraform language server. More stable than *terraform-lsp* but
currently has less features.

g:ale_terraform_ls_executable                   *g:ale_terraform_ls_executable*
                                                *b:ale_terraform_ls_executable*
  Type: |String|
  Default: `'terraform-ls'`

  This variable can be changed to use a different executable for terraform-ls.


g:ale_terraform_ls_options                         *g:ale_terraform_ls_options*
                                                   *b: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*

g:ale_terraform_langserver_executable   *g:ale_terraform_langserver_executable*
                                        *b:ale_terraform_langserver_executable*
  Type: |String|
  Default: `'terraform-lsp'`

  This variable can be changed to use a different executable for terraform-lsp.


g:ale_terraform_langserver_options         *g:ale_terraform_langserver_options*
                                           *b:ale_terraform_langserver_options*
  Type: |String|
  Default: `''`

  This variable can be changed to pass custom CLI flags to terraform-lsp.


===============================================================================
tflint                                                   *ale-terraform-tflint*

g:ale_terraform_tflint_executable           *g:ale_terraform_tflint_executable*
                                            *b:ale_terraform_tflint_executable*

  Type: |String|
  Default: `'tflint'`

  This variable can be changed to use a different executable for tflint.


g:ale_terraform_tflint_options                 *g:ale_terraform_tflint_options*
                                               *b: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*

g:ale_terraform_tfsec_executable             *g:ale_terraform_tfsec_executable*
                                             *b:ale_terraform_tfsec_executable*

  Type: |String|
  Default: `'tfsec'`

  This variable can be changed to use a different executable for tfsec.

g:ale_terraform_tfsec_options                *g:ale_terraform_tfsec_executable*
                                             *b:ale_terraform_tfsec_executable*

  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: