mirror of
https://github.com/dense-analysis/ale.git
synced 2026-05-17 05:49:47 +08:00
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:
+28
-14
@@ -5,19 +5,22 @@ ALE Dockerfile Integration *ale-dockerfile-options*
|
||||
===============================================================================
|
||||
dockerfile_lint *ale-dockerfile-dockerfile_lint*
|
||||
|
||||
g:ale_dockerfile_dockerfile_lint_executable
|
||||
*ale-options.dockerfile_dockerfile_lint_executable*
|
||||
*g:ale_dockerfile_dockerfile_lint_executable*
|
||||
*b:ale_dockerfile_dockerfile_lint_executable*
|
||||
dockerfile_dockerfile_lint_executable
|
||||
g:ale_dockerfile_dockerfile_lint_executable
|
||||
Type: |String|
|
||||
Default: `'dockerfile_lint'`
|
||||
|
||||
This variable can be changed to specify the executable used to run
|
||||
dockerfile_lint.
|
||||
|
||||
|
||||
g:ale_dockerfile_dockerfile_lint_options
|
||||
*ale-options.dockerfile_dockerfile_lint_options*
|
||||
*g:ale_dockerfile_dockerfile_lint_options*
|
||||
*b:ale_dockerfile_dockerfile_lint_options*
|
||||
dockerfile_dockerfile_lint_options
|
||||
g:ale_dockerfile_dockerfile_lint_options
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
@@ -28,9 +31,11 @@ g:ale_dockerfile_dockerfile_lint_options
|
||||
===============================================================================
|
||||
dockerlinter *ale-dockerfile-dockerlinter*
|
||||
|
||||
g:ale_dockerfile_dockerlinter_executable
|
||||
*ale-options.dockerfile_dockerlinter_executable*
|
||||
*g:ale_dockerfile_dockerlinter_executable*
|
||||
*b:ale_dockerfile_dockerlinter_executable*
|
||||
dockerfile_dockerlinter_executable
|
||||
g:ale_dockerfile_dockerlinter_executable
|
||||
Type: |String|
|
||||
Default: `'dockerlinter'`
|
||||
|
||||
@@ -38,17 +43,17 @@ g:ale_dockerfile_dockerlinter_executable
|
||||
dockerlinter.
|
||||
|
||||
|
||||
g:ale_dockerfile_dockerlinter_options
|
||||
*ale-options.dockerfile_dockerlinter_options*
|
||||
*g:ale_dockerfile_dockerlinter_options*
|
||||
*b:ale_dockerfile_dockerlinter_options*
|
||||
dockerfile_dockerlinter_options
|
||||
g:ale_dockerfile_dockerlinter_options
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to add additional command-line arguments to
|
||||
the dockerfile lint invocation - like custom rule file definitions.
|
||||
|
||||
dockerlinter
|
||||
|
||||
|
||||
===============================================================================
|
||||
dprint *ale-dockerfile-dprint*
|
||||
@@ -59,11 +64,16 @@ See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
|
||||
===============================================================================
|
||||
hadolint *ale-dockerfile-hadolint*
|
||||
|
||||
hadolint can be found at: https://github.com/hadolint/hadolint
|
||||
hadolint can be found at: https://github.com/hadolint/hadolint
|
||||
|
||||
|
||||
g:ale_dockerfile_hadolint_options *g:ale_dockerfile_hadolint_options*
|
||||
-------------------------------------------------------------------------------
|
||||
Options
|
||||
*ale-options.dockerfile_hadolint_options*
|
||||
*g:ale_dockerfile_hadolint_options*
|
||||
*b:ale_dockerfile_hadolint_options*
|
||||
dockerfile_hadolint_options
|
||||
g:ale_dockerfile_hadolint_options
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
@@ -71,9 +81,11 @@ g:ale_dockerfile_hadolint_options *g:ale_dockerfile_hadolint_options*
|
||||
invocation. These arguments will be used whether docker is being used or not
|
||||
(see below).
|
||||
|
||||
|
||||
g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
|
||||
*ale-options.dockerfile_hadolint_use_docker*
|
||||
*g:ale_dockerfile_hadolint_use_docker*
|
||||
*b:ale_dockerfile_hadolint_use_docker*
|
||||
dockerfile_hadolint_use_docker
|
||||
g:ale_dockerfile_hadolint_use_docker
|
||||
Type: |String|
|
||||
Default: `'never'`
|
||||
|
||||
@@ -85,16 +97,18 @@ g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
|
||||
For now, the default is 'never'. This may change as ale's support for using
|
||||
docker to lint evolves.
|
||||
|
||||
|
||||
g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image*
|
||||
*ale-options.dockerfile_hadolint_image*
|
||||
*g:ale_dockerfile_hadolint_image*
|
||||
*b:ale_dockerfile_hadolint_image*
|
||||
dockerfile_hadolint_image
|
||||
g:ale_dockerfile_hadolint_image
|
||||
Type: |String|
|
||||
Default: `'hadolint/hadolint'`
|
||||
|
||||
This variable controls the docker image used to run hadolint. The default
|
||||
is hadolint's author's build, and can be found at:
|
||||
|
||||
https://hub.docker.com/r/hadolint/hadolint/
|
||||
https://hub.docker.com/r/hadolint/hadolint/
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
||||
Reference in New Issue
Block a user