Implement Lua ALE setup & overhaul documentation

1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
+54 -25
View File
@@ -5,36 +5,45 @@ ALE Terraform Integration *ale-terraform-options*
===============================================================================
checkov *ale-terraform-checkov*
g:ale_terraform_checkov_executable *g:ale_terraform_checkov_executable*
*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.
g:ale_terraform_checkov_options *g:ale_terraform_checkov_options*
*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*
g:ale_terraform_fmt_executable *g:ale_terraform_fmt_executable*
*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.
g:ale_terraform_fmt_options *g:ale_terraform_fmt_options*
*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: `''`
@@ -42,9 +51,11 @@ g:ale_terraform_fmt_options *g:ale_terraform_fmt_options*
===============================================================================
terraform *ale-terraform-terraform*
g:ale_terraform_terraform_executable *g:ale_terraform_terraform_executable*
*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'`
@@ -57,16 +68,21 @@ 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*
*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.
g:ale_terraform_ls_options *g:ale_terraform_ls_options*
*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: `''`
@@ -76,16 +92,21 @@ g:ale_terraform_ls_options *g:ale_terraform_ls_options*
===============================================================================
terraform-lsp *ale-terraform-terraform-lsp*
g:ale_terraform_langserver_executable *g:ale_terraform_langserver_executable*
*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.
g:ale_terraform_langserver_options *g:ale_terraform_langserver_options*
*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: `''`
@@ -95,17 +116,21 @@ g:ale_terraform_langserver_options *g:ale_terraform_langserver_options*
===============================================================================
tflint *ale-terraform-tflint*
g:ale_terraform_tflint_executable *g:ale_terraform_tflint_executable*
*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.
g:ale_terraform_tflint_options *g:ale_terraform_tflint_options*
*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'`
@@ -117,22 +142,26 @@ g:ale_terraform_tflint_options *g:ale_terraform_tflint_options*
===============================================================================
tfsec *ale-terraform-tfsec*
g:ale_terraform_tfsec_executable *g:ale_terraform_tfsec_executable*
*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.
g:ale_terraform_tfsec_options *g:ale_terraform_tfsec_options*
*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: