Files
ale/doc/ale-dockerfile.txt
w0rp 400857d758 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.
2025-03-27 12:40:11 +00:00

116 lines
4.7 KiB
Plaintext

===============================================================================
ALE Dockerfile Integration *ale-dockerfile-options*
===============================================================================
dockerfile_lint *ale-dockerfile-dockerfile_lint*
*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.
*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: `''`
This variable can be changed to add additional command-line arguments to
the dockerfile lint invocation - like custom rule file definitions.
===============================================================================
dockerlinter *ale-dockerfile-dockerlinter*
*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'`
This variable can be changed to specify the executable used to run
dockerlinter.
*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.
===============================================================================
dprint *ale-dockerfile-dprint*
See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
===============================================================================
hadolint *ale-dockerfile-hadolint*
hadolint can be found at: https://github.com/hadolint/hadolint
-------------------------------------------------------------------------------
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: `''`
This variable can be changed to add command-line arguments to the hadolint
invocation. These arguments will be used whether docker is being used or not
(see below).
*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'`
This variable controls if docker and the hadolint image are used to run this
linter: if 'never', docker will never be used; 'always' means docker will
always be used; 'yes' and docker will be used if the hadolint executable
cannot be found.
For now, the default is 'never'. This may change as ale's support for using
docker to lint evolves.
*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/
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: