*ale.txt* For Vim version 8.0. *ale* ALE - Asynchronous Lint Engine =============================================================================== CONTENTS *ale-contents* 1. Introduction.........................|ale-introduction| 2. Supported Languages & Tools..........|ale-support| 3. Linting..............................|ale-lint| 3.1 Other Sources.....................|ale-lint-other-sources| 4. Fixing Problems......................|ale-fix| 5. Language Server Protocol Support.....|ale-lsp| 5.1 Completion........................|ale-completion| 5.2 Go To Definition..................|ale-go-to-definition| 5.3 Go To Type Definition.............|ale-go-to-type-definition| 5.4 Find References...................|ale-find-references| 5.5 Hovering..........................|ale-hover| 5.6 Symbol Search.....................|ale-symbol-search| 6. Global Options.......................|ale-options| 6.1 Highlights........................|ale-highlights| 7. Linter/Fixer Options.................|ale-integration-options| 7.1 Options for alex..................|ale-alex-options| 7.2 Options for languagetool..........|ale-languagetool-options| 7.3 Options for write-good............|ale-write-good-options| 7.4 Other Linter/Fixer Options........|ale-other-integration-options| 8. Commands/Keybinds....................|ale-commands| 9. API..................................|ale-api| 10. Special Thanks......................|ale-special-thanks| 11. Contact.............................|ale-contact| =============================================================================== 1. Introduction *ale-introduction* ALE provides the means to run linters asynchronously in Vim in a variety of languages and tools. ALE sends the contents of buffers to linter programs using the |job-control| features available in Vim 8 and NeoVim. For Vim 8, Vim must be compiled with the |job| and |channel| and |timers| features as a minimum. ALE supports the following key features for linting: 1. Running linters when text is changed. 2. Running linters when files are opened. 3. Running linters when files are saved. (When a global flag is set.) 4. Populating the |loclist| with warning and errors. 5. Setting |signs| with warnings and errors for error markers. 6. Using |echo| to show error messages when the cursor moves. 7. Setting syntax highlights for errors. ada...................................|ale-ada-options| gcc.................................|ale-ada-gcc| ansible...............................|ale-ansible-options| ansible-lint........................|ale-ansible-ansible-lint| asciidoc..............................|ale-asciidoc-options| write-good..........................|ale-asciidoc-write-good| textlint............................|ale-asciidoc-textlint| asm...................................|ale-asm-options| gcc.................................|ale-asm-gcc| awk...................................|ale-awk-options| gawk................................|ale-awk-gawk| bib...................................|ale-bib-options| bibclean............................|ale-bib-bibclean| c.....................................|ale-c-options| clang...............................|ale-c-clang| clangd..............................|ale-c-clangd| clang-format........................|ale-c-clangformat| clangtidy...........................|ale-c-clangtidy| cppcheck............................|ale-c-cppcheck| cquery..............................|ale-c-cquery| flawfinder..........................|ale-c-flawfinder| gcc.................................|ale-c-gcc| uncrustify..........................|ale-c-uncrustify| ccls................................|ale-c-ccls| chef..................................|ale-chef-options| foodcritic..........................|ale-chef-foodcritic| clojure...............................|ale-clojure-options| joker...............................|ale-clojure-joker| cloudformation........................|ale-cloudformation-options| cfn-python-lint.....................|ale-cloudformation-cfn-python-lint| cmake.................................|ale-cmake-options| cmakelint...........................|ale-cmake-cmakelint| cmake-format........................|ale-cmake-cmakeformat| cpp...................................|ale-cpp-options| clang...............................|ale-cpp-clang| clangd..............................|ale-cpp-clangd| clangcheck..........................|ale-cpp-clangcheck| clang-format........................|ale-cpp-clangformat| clangtidy...........................|ale-cpp-clangtidy| clazy...............................|ale-cpp-clazy| cppcheck............................|ale-cpp-cppcheck| cpplint.............................|ale-cpp-cpplint| cquery..............................|ale-cpp-cquery| flawfinder..........................|ale-cpp-flawfinder| gcc.................................|ale-cpp-gcc| uncrustify..........................|ale-cpp-uncrustify| ccls................................|ale-cpp-ccls| c#....................................|ale-cs-options| mcs.................................|ale-cs-mcs| mcsc................................|ale-cs-mcsc| uncrustify..........................|ale-cs-uncrustify| css...................................|ale-css-options| prettier............................|ale-css-prettier| stylelint...........................|ale-css-stylelint| cuda..................................|ale-cuda-options| nvcc................................|ale-cuda-nvcc| clang-format........................|ale-cuda-clangformat| d.....................................|ale-d-options| dls.................................|ale-d-dls| uncrustify..........................|ale-d-uncrustify| dart..................................|ale-dart-options| dartanalyzer........................|ale-dart-dartanalyzer| dartfmt.............................|ale-dart-dartfmt| dockerfile............................|ale-dockerfile-options| dockerfile_lint.....................|ale-dockerfile-dockerfile_lint| hadolint............................|ale-dockerfile-hadolint| elixir................................|ale-elixir-options| mix.................................|ale-elixir-mix| mix_format..........................|ale-elixir-mix-format| dialyxir............................|ale-elixir-dialyxir| elixir-ls...........................|ale-elixir-elixir-ls| credo...............................|ale-elixir-credo| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-lsp.............................|ale-elm-elm-lsp| elm-make............................|ale-elm-elm-make| erlang................................|ale-erlang-options| erlc................................|ale-erlang-erlc| syntaxerl...........................|ale-erlang-syntaxerl| eruby.................................|ale-eruby-options| ruumba..............................|ale-eruby-ruumba| fish..................................|ale-fish-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| language_server.....................|ale-fortran-language-server| fountain..............................|ale-fountain-options| fusionscript..........................|ale-fuse-options| fusion-lint.........................|ale-fuse-fusionlint| git commit............................|ale-gitcommit-options| gitlint.............................|ale-gitcommit-gitlint| glsl..................................|ale-glsl-options| glslang.............................|ale-glsl-glslang| glslls..............................|ale-glsl-glslls| go....................................|ale-go-options| gobuild.............................|ale-go-gobuild| gofmt...............................|ale-go-gofmt| golint..............................|ale-go-golint| govet...............................|ale-go-govet| gometalinter........................|ale-go-gometalinter| staticcheck.........................|ale-go-staticcheck| golangserver........................|ale-go-golangserver| golangci-lint.......................|ale-go-golangci-lint| bingo...............................|ale-go-bingo| graphql...............................|ale-graphql-options| eslint..............................|ale-graphql-eslint| gqlint..............................|ale-graphql-gqlint| prettier............................|ale-graphql-prettier| hack..................................|ale-hack-options| hack................................|ale-hack-hack| hackfmt.............................|ale-hack-hackfmt| hhast...............................|ale-hack-hhast| handlebars............................|ale-handlebars-options| ember-template-lint.................|ale-handlebars-embertemplatelint| haskell...............................|ale-haskell-options| brittany............................|ale-haskell-brittany| ghc.................................|ale-haskell-ghc| ghc-mod.............................|ale-haskell-ghc-mod| cabal-ghc...........................|ale-haskell-cabal-ghc| hdevtools...........................|ale-haskell-hdevtools| hfmt................................|ale-haskell-hfmt| hlint...............................|ale-haskell-hlint| stack-build.........................|ale-haskell-stack-build| stack-ghc...........................|ale-haskell-stack-ghc| stylish-haskell.....................|ale-haskell-stylish-haskell| hie.................................|ale-haskell-hie| hcl...................................|ale-hcl-options| terraform-fmt.......................|ale-hcl-terraform-fmt| html..................................|ale-html-options| htmlhint............................|ale-html-htmlhint| tidy................................|ale-html-tidy| prettier............................|ale-html-prettier| stylelint...........................|ale-html-stylelint| write-good..........................|ale-html-write-good| idris.................................|ale-idris-options| idris...............................|ale-idris-idris| ispc..................................|ale-ispc-options| ispc................................|ale-ispc-ispc| java..................................|ale-java-options| checkstyle..........................|ale-java-checkstyle| javac...............................|ale-java-javac| google-java-format..................|ale-java-google-java-format| pmd.................................|ale-java-pmd| javalsp.............................|ale-java-javalsp| uncrustify..........................|ale-java-uncrustify| javascript............................|ale-javascript-options| eslint..............................|ale-javascript-eslint| flow................................|ale-javascript-flow| importjs............................|ale-javascript-importjs| jscs................................|ale-javascript-jscs| jshint..............................|ale-javascript-jshint| prettier............................|ale-javascript-prettier| prettier-eslint.....................|ale-javascript-prettier-eslint| prettier-standard...................|ale-javascript-prettier-standard| standard............................|ale-javascript-standard| xo..................................|ale-javascript-xo| json..................................|ale-json-options| fixjson.............................|ale-json-fixjson| jsonlint............................|ale-json-jsonlint| jq..................................|ale-json-jq| prettier............................|ale-json-prettier| julia.................................|ale-julia-options| languageserver......................|ale-julia-languageserver| kotlin................................|ale-kotlin-options| kotlinc.............................|ale-kotlin-kotlinc| ktlint..............................|ale-kotlin-ktlint| languageserver......................|ale-kotlin-languageserver| latex.................................|ale-latex-options| write-good..........................|ale-latex-write-good| textlint............................|ale-latex-textlint| less..................................|ale-less-options| lessc...............................|ale-less-lessc| prettier............................|ale-less-prettier| stylelint...........................|ale-less-stylelint| llvm..................................|ale-llvm-options| llc.................................|ale-llvm-llc| lua...................................|ale-lua-options| luac................................|ale-lua-luac| luacheck............................|ale-lua-luacheck| markdown..............................|ale-markdown-options| mdl.................................|ale-markdown-mdl| prettier............................|ale-markdown-prettier| remark-lint.........................|ale-markdown-remark-lint| textlint............................|ale-markdown-textlint| write-good..........................|ale-markdown-write-good| mercury...............................|ale-mercury-options| mmc.................................|ale-mercury-mmc| nasm..................................|ale-nasm-options| nasm................................|ale-nasm-nasm| nroff.................................|ale-nroff-options| write-good..........................|ale-nroff-write-good| objc..................................|ale-objc-options| clang...............................|ale-objc-clang| clangd..............................|ale-objc-clangd| uncrustify..........................|ale-objc-uncrustify| ccls................................|ale-objc-ccls| objcpp................................|ale-objcpp-options| clang...............................|ale-objcpp-clang| clangd..............................|ale-objcpp-clangd| uncrustify..........................|ale-objcpp-uncrustify| ocaml.................................|ale-ocaml-options| merlin..............................|ale-ocaml-merlin| ols.................................|ale-ocaml-ols| ocamlformat.........................|ale-ocaml-ocamlformat| pawn..................................|ale-pawn-options| uncrustify..........................|ale-pawn-uncrustify| perl..................................|ale-perl-options| perl................................|ale-perl-perl| perlcritic..........................|ale-perl-perlcritic| perltidy............................|ale-perl-perltidy| perl6.................................|ale-perl6-options| perl6...............................|ale-perl6-perl6| php...................................|ale-php-options| langserver..........................|ale-php-langserver| phan................................|ale-php-phan| phpcbf..............................|ale-php-phpcbf| phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| psalm...............................|ale-php-psalm| php-cs-fixer........................|ale-php-php-cs-fixer| php.................................|ale-php-php| po....................................|ale-po-options| write-good..........................|ale-po-write-good| pod...................................|ale-pod-options| write-good..........................|ale-pod-write-good| pony..................................|ale-pony-options| ponyc...............................|ale-pony-ponyc| powershell............................|ale-powershell-options| psscriptanalyzer....................|ale-powershell-psscriptanalyzer| prolog................................|ale-prolog-options| swipl...............................|ale-prolog-swipl| proto.................................|ale-proto-options| protoc-gen-lint.....................|ale-proto-protoc-gen-lint| pug...................................|ale-pug-options| puglint.............................|ale-pug-puglint| puppet................................|ale-puppet-options| puppet..............................|ale-puppet-puppet| puppetlint..........................|ale-puppet-puppetlint| puppet-languageserver...............|ale-puppet-languageserver| pyrex (cython)........................|ale-pyrex-options| cython..............................|ale-pyrex-cython| python................................|ale-python-options| autopep8............................|ale-python-autopep8| bandit..............................|ale-python-bandit| black...............................|ale-python-black| flake8..............................|ale-python-flake8| isort...............................|ale-python-isort| mypy................................|ale-python-mypy| prospector..........................|ale-python-prospector| pycodestyle.........................|ale-python-pycodestyle| pydocstyle..........................|ale-python-pydocstyle| pyflakes............................|ale-python-pyflakes| pylama..............................|ale-python-pylama| pylint..............................|ale-python-pylint| pyls................................|ale-python-pyls| pyre................................|ale-python-pyre| vulture.............................|ale-python-vulture| yapf................................|ale-python-yapf| qml...................................|ale-qml-options| qmlfmt..............................|ale-qml-qmlfmt| r.....................................|ale-r-options| lintr...............................|ale-r-lintr| reasonml..............................|ale-reasonml-options| merlin..............................|ale-reasonml-merlin| ols.................................|ale-reasonml-ols| refmt...............................|ale-reasonml-refmt| restructuredtext......................|ale-restructuredtext-options| textlint............................|ale-restructuredtext-textlint| write-good..........................|ale-restructuredtext-write-good| ruby..................................|ale-ruby-options| brakeman............................|ale-ruby-brakeman| rails_best_practices................|ale-ruby-rails_best_practices| reek................................|ale-ruby-reek| rubocop.............................|ale-ruby-rubocop| ruby................................|ale-ruby-ruby| rufo................................|ale-ruby-rufo| solargraph..........................|ale-ruby-solargraph| standardrb..........................|ale-ruby-standardrb| rust..................................|ale-rust-options| cargo...............................|ale-rust-cargo| rls.................................|ale-rust-rls| rustc...............................|ale-rust-rustc| rustfmt.............................|ale-rust-rustfmt| sass..................................|ale-sass-options| sasslint............................|ale-sass-sasslint| stylelint...........................|ale-sass-stylelint| scala.................................|ale-scala-options| sbtserver...........................|ale-scala-sbtserver| scalafmt............................|ale-scala-scalafmt| scalastyle..........................|ale-scala-scalastyle| scss..................................|ale-scss-options| prettier............................|ale-scss-prettier| sasslint............................|ale-scss-sasslint| stylelint...........................|ale-scss-stylelint| sh....................................|ale-sh-options| sh-language-server..................|ale-sh-language-server| shell...............................|ale-sh-shell| shellcheck..........................|ale-sh-shellcheck| shfmt...............................|ale-sh-shfmt| sml...................................|ale-sml-options| smlnj...............................|ale-sml-smlnj| solidity..............................|ale-solidity-options| solhint.............................|ale-solidity-solhint| solium..............................|ale-solidity-solium| spec..................................|ale-spec-options| rpmlint.............................|ale-spec-rpmlint| sql...................................|ale-sql-options| sqlfmt..............................|ale-sql-sqlfmt| stylus................................|ale-stylus-options| stylelint...........................|ale-stylus-stylelint| sugarss...............................|ale-sugarss-options| stylelint...........................|ale-sugarss-stylelint| tcl...................................|ale-tcl-options| nagelfar............................|ale-tcl-nagelfar| terraform.............................|ale-terraform-options| fmt.................................|ale-terraform-fmt| tflint..............................|ale-terraform-tflint| tex...................................|ale-tex-options| chktex..............................|ale-tex-chktex| lacheck.............................|ale-tex-lacheck| texinfo...............................|ale-texinfo-options| write-good..........................|ale-texinfo-write-good| text..................................|ale-text-options| textlint............................|ale-text-textlint| write-good..........................|ale-text-write-good| thrift................................|ale-thrift-options| thrift..............................|ale-thrift-thrift| typescript............................|ale-typescript-options| eslint..............................|ale-typescript-eslint| prettier............................|ale-typescript-prettier| tslint..............................|ale-typescript-tslint| tsserver............................|ale-typescript-tsserver| vala..................................|ale-vala-options| uncrustify..........................|ale-vala-uncrustify| verilog/systemverilog.................|ale-verilog-options| iverilog............................|ale-verilog-iverilog| verilator...........................|ale-verilog-verilator| vlog................................|ale-verilog-vlog| xvlog...............................|ale-verilog-xvlog| vhdl..................................|ale-vhdl-options| ghdl................................|ale-vhdl-ghdl| vcom................................|ale-vhdl-vcom| xvhdl...............................|ale-vhdl-xvhdl| vim...................................|ale-vim-options| vint................................|ale-vim-vint| vim help..............................|ale-vim-help-options| write-good..........................|ale-vim-help-write-good| vue...................................|ale-vue-options| prettier............................|ale-vue-prettier| vls.................................|ale-vue-vls| xhtml.................................|ale-xhtml-options| write-good..........................|ale-xhtml-write-good| xml...................................|ale-xml-options| xmllint.............................|ale-xml-xmllint| yaml..................................|ale-yaml-options| prettier............................|ale-yaml-prettier| swaglint............................|ale-yaml-swaglint| yamllint............................|ale-yaml-yamllint| yang..................................|ale-yang-options| yang-lsp............................|ale-yang-lsp| ALE can fix problems with files with the |ALEFix| command, using the same job control functionality used for checking for problems. Try using the |ALEFixSuggest| command for browsing tools that can be used to fix problems for the current buffer. If you are interested in contributing to the development of ALE, read the developer documentation. See |ale-development| =============================================================================== 2. Supported Languages & Tools *ale-support* ALE supports a wide variety of languages and tools. See |ale-supported-list| for the full list. =============================================================================== 3. Linting *ale-lint* ALE's primary focus is on checking for problems with your code with various programs via some Vim code for integrating with those programs, referred to as 'linters.' ALE supports a wide array of programs for linting by default, but additional programs can be added easily by defining files in |runtimepath| with the filename pattern `ale_linters//.vim`. For more information on defining new linters, see the extensive documentation for |ale#linter#Define()|. Without any configuration, ALE will attempt to check all of the code for every file you open in Vim with all available tools by default. To see what ALE is doing, and what options have been set, try using the |:ALEInfo| command. Most of the linters ALE runs will check the Vim buffer you are editing instead of the file on disk. This allows you to check your code for errors before you have even saved your changes. ALE will check your code in the following circumstances, which can be configured with the associated options. * When you modify a buffer. - |g:ale_lint_on_text_changed| * On leaving insert mode. (off by default) - |g:ale_lint_on_insert_leave| * When you open a new or modified buffer. - |g:ale_lint_on_enter| * When you save a buffer. - |g:ale_lint_on_save| * When the filetype changes for a buffer. - |g:ale_lint_on_filetype_changed| * If ALE is used to check code manually. - |:ALELint| *ale-lint-settings-on-startup* It is worth reading the documentation for every option. You should configure which events ALE will use before ALE is loaded, so it can optimize which autocmd commands to run. You can force autocmd commands to be reloaded with `:ALEDisable | ALEEnable` This also applies to the autocmd commands used for |g:ale_echo_cursor|. *ale-lint-file-linters* Some programs must be run against files which have been saved to disk, and simply do not support reading temporary files or stdin, either of which are required for ALE to be able to check for errors as you type. The programs which behave this way are documented in the lists and tables of supported programs. ALE will only lint files with these programs in the following circumstances. * When you open a new or modified buffer. - |g:ale_lint_on_enter| * When you save a buffer. - |g:ale_lint_on_save| * When the filetype changes for a buffer. - |g:ale_lint_on_filetype_changed| * If ALE is used to check code manually. - |:ALELint| ALE will report problems with your code in the following ways, listed with their relevant options. * By updating loclist. (On by default) - |g:ale_set_loclist| * By updating quickfix. (Off by default) - |g:ale_set_quickfix| * By setting error highlights. - |g:ale_set_highlights| * By creating signs in the sign column. - |g:ale_set_signs| * By echoing messages based on your cursor. - |g:ale_echo_cursor| * By inline text based on your cursor. - |g:ale_virtualtext_cursor| * By displaying the preview based on your cursor. - |g:ale_cursor_detail| * By showing balloons for your mouse cursor - |g:ale_set_balloons| Please consult the documentation for each option, which can reveal some other ways of tweaking the behaviour of each way of displaying problems. You can disable or enable whichever options you prefer. Most settings can be configured for each buffer. (|b:| instead of |g:|), including disabling ALE for certain buffers with |b:ale_enabled|. The |g:ale_pattern_options| setting can be used to configure files differently based on regular expressions for filenames. For configuring entire projects, the buffer-local options can be used with external plugins for reading Vim project configuration files. Buffer-local settings can also be used in ftplugin files for different filetypes. ALE offers several options for controlling which linters are run. * Selecting linters to run. - |g:ale_linters| * Aliasing filetypes for linters - |g:ale_linter_aliases| * Only running linters you asked for. - |g:ale_linters_explicit| ------------------------------------------------------------------------------- 3.1 Other Sources *ale-lint-other-sources* Problems for a buffer can be taken from other sources and rendered by ALE. This allows ALE to be used in combination with other plugins which also want to display any problems they might find with a buffer. ALE's API includes the following components for making this possible. * |ale#other_source#StartChecking()| - Tell ALE that a buffer is being checked. * |ale#other_source#ShowResults()| - Show results from another source. * |ALEWantResults| - A signal for when ALE wants results. Other resources can provide results for ALE to display at any time, following ALE's loclist format. (See |ale-loclist-format|) For example: > " Tell ALE to show some results. " This function can be called at any time. call ale#other_source#ShowResults(bufnr(''), 'some-linter-name', [ \ {'text': 'Something went wrong', 'lnum': 13}, \]) < Other sources should use a unique name for identifying themselves. A single linter name can be used for all problems from another source, or a series of unique linter names can be used. Results can be cleared for that source by providing an empty List. |ale#other_source#StartChecking()| should be called whenever another source starts checking a buffer, so other tools can know that a buffer is being checked by some plugin. The |ALEWantResults| autocmd event can be used to start checking a buffer for problems every time that ALE does. When |ALEWantResults| is signaled, |g:ale_want_results_buffer| will be set to the number of the buffer that ALE wants to check. |ale#other_source#StartChecking()| should be called synchronously, and other sources should perform their checks on a buffer in the background asynchronously, so they don't interrupt editing. A plugin might integrate its own checks with ALE like so: > augroup SomeGroupName autocmd! autocmd User ALEWantResults call Hook(g:ale_want_results_buffer) augroup END function! DoBackgroundWork(buffer) abort " Start some work in the background here. " ... " Then call WorkDone(a:buffer, results) endfunction function! Hook(buffer) abort " Tell ALE we're going to check this buffer. call ale#other_source#StartChecking(a:buffer, 'some-name') call DoBackgroundWork(a:buffer) endfunction function! WorkDone(buffer, results) abort " Send results to ALE after they have been collected. call ale#other_source#ShowResults(buffer, 'some-name', a:results) endfunction < =============================================================================== 4. Fixing Problems *ale-fix* ALE can fix problems with files with the |ALEFix| command. |ALEFix| accepts names of fixers to be applied as arguments. Alternatively, when no arguments are provided, the variable |g:ale_fixers| will be read for getting a |List| of commands for filetypes, split on `.`, and the functions named in |g:ale_fixers| will be executed for fixing the errors. The |ALEFixSuggest| command can be used to suggest tools that be used to fix problems for the current buffer. The values for `g:ale_fixers` can be a list of |String|, |Funcref|, or |lambda| values. String values must either name a function, or a short name for a function set in the ALE fixer registry. Each function for fixing errors must accept either one argument `(buffer)` or two arguments `(buffer, lines)`, representing the buffer being fixed and the lines to fix. The functions must return either `0`, for changing nothing, a |List| for new lines to set, a |Dictionary| for describing a command to be run in the background, or the result of |ale#command#Run()|. Functions receiving a variable number of arguments will not receive the second argument `lines`. Functions should name two arguments if the `lines` argument is desired. This is required to avoid unnecessary copying of the lines of the buffers being checked. When a |Dictionary| is returned for an |ALEFix| callback, the following keys are supported for running the commands. `command` A |String| for the command to run. This key is required. When `%t` is included in a command string, a temporary file will be created, containing the lines from the file after previous adjustment have been done. `read_temporary_file` When set to `1`, ALE will read the contents of the temporary file created for `%t`. This option can be used for commands which need to modify some file on disk in order to fix files. `process_with` An optional callback for post-processing. The callback must accept two arguments, `(buffer, output)`, which can be used for converting the output from a command into lines to replace the buffer's contents with. A |List| of |String|s must be returned. `read_buffer` An optional key for disabling reading the buffer. When set to `0`, ALE will not pipe the buffer's data into the command via stdin. This option is ignored and the buffer is not read when `read_temporary_file` is `1`. This option defaults to `1`. *ale-fix-configuration* Synchronous functions and asynchronous jobs will be run in a sequence for fixing files, and can be combined. For example: > let g:ale_fixers = { \ 'javascript': [ \ 'DoSomething', \ 'eslint', \ {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')}, \ ], \} ALEFix < The above example will call a function called `DoSomething` which could act upon some lines immediately, then run `eslint` from the ALE registry, and then call a lambda function which will remove every single line comment from the file. For buffer-local settings, such as in |g:ale_pattern_options| or in ftplugin files, a |List| may be used for configuring the fixers instead. > " Same as the above, only a List can be used instead of a Dictionary. let b:ale_fixers = [ \ 'DoSomething', \ 'eslint', \ {buffer, lines -> filter(lines, 'v:val !=~ ''^\s*//''')}, \] ALEFix < For convenience, a plug mapping is defined for |ALEFix|, so you can set up a keybind easily for fixing files. > " Bind F8 to fixing problems with ALE nmap (ale_fix) < Files can be fixed automatically with the following options, which are all off by default. |g:ale_fix_on_save| - Fix files when they are saved. =============================================================================== 5. Language Server Protocol Support *ale-lsp* ALE offers some support for integrating with Language Server Protocol (LSP) servers. LSP linters can be used in combination with any other linter, and will automatically connect to LSP servers when needed. ALE also supports `tsserver` for TypeScript, which uses a different but very similar protocol. ALE supports the following LSP/tsserver features: 1. Diagnostics/linting - Enabled via selecting linters as usual. 2. Completion 3. Go to definition ------------------------------------------------------------------------------- 5.1 Completion *ale-completion* ALE offers limited support for automatic completion of code while you type. Completion is only supported while at least one LSP linter is enabled. ALE will only suggest symbols provided by the LSP servers. Suggestions will be made while you type after completion is enabled. Completion can be enabled by setting |g:ale_completion_enabled| to `1`. This setting must be set to `1` before ALE is loaded. The delay for completion can be configured with |g:ale_completion_delay|. ALE will only suggest so many possible matches for completion. The maximum number of items can be controlled with |g:ale_completion_max_suggestions|. If you don't like some of the suggestions you see, you can filter them out with |g:ale_completion_excluded_words| or |b:ale_completion_excluded_words|. The |ALEComplete| command can be used to show completion suggestions manually, even when |g:ale_completion_enabled| is set to `0`. *ale-completion-completeopt-bug* Automatic completion replaces |completeopt| before opening the omnicomplete menu with . In some versions of Vim, the value set for the option will not be respected. If you experience issues with Vim automatically inserting text while you type, set the following option in vimrc, and your issues should go away. > set completeopt=menu,menuone,preview,noselect,noinsert < ------------------------------------------------------------------------------- 5.2 Go To Definition *ale-go-to-definition* ALE supports jumping to the files and locations where symbols are defined through any enabled LSP linters. The locations ALE will jump to depend on the information returned by LSP servers. The following commands are supported: |ALEGoToDefinition| - Open the definition of the symbol under the cursor. |ALEGoToDefinitionInTab| - The same, but for opening the file in a new tab. |ALEGoToDefinitionInSplit| - The same, but in a new split. |ALEGoToDefinitionInVSplit| - The same, but in a new vertical split. ------------------------------------------------------------------------------- 5.3 Go To Type Definition *ale-go-to-type-definition* ALE supports jumping to the files and locations where symbols' types are defined through any enabled LSP linters. The locations ALE will jump to depend on the information returned by LSP servers. The following commands are supported: |ALEGoToTypeDefinition| - Open the definition of the symbol's type under the cursor. |ALEGoToTypeDefinitionInTab| - The same, but for opening the file in a new tab. |ALEGoToTypeDefinitionInSplit| - The same, but in a new split. |ALEGoToTypeDefinitionInVSplit| - The same, but in a new vertical split. ------------------------------------------------------------------------------- 5.4 Find References *ale-find-references* ALE supports finding references for symbols though any enabled LSP linters. ALE will display a preview window showing the places where a symbol is referenced in a codebase when a command is run. The following commands are supported: |ALEFindReferences| - Find references for the word under the cursor. Options: `-relative` Show file paths in the results relative to the working dir ------------------------------------------------------------------------------- 5.5 Hovering *ale-hover* ALE supports "hover" information for printing brief information about symbols at the cursor taken from LSP linters. The following commands are supported: |ALEHover| - Print information about the symbol at the cursor. If |g:ale_set_balloons| is set to `1` and your version of Vim supports the |balloon_show()| function, then "hover" information also show up when you move the mouse over a symbol in a buffer. Diagnostic information will take priority over hover information for balloons. If a line contains a problem, that problem will be displayed in a balloon instead of hover information. For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling |balloonexpr| commands in terminals can cause scrolling issues in terminals, so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to `1` before ALE is loaded. For enabling mouse support in terminals, you may have to change your mouse settings. For example: > " Example mouse settings. " You will need to try different settings, depending on your terminal. set mouse=a set ttymouse=xterm < Documentation for symbols at the cursor can be retrieved using the |ALEDocumentation| command. This command is only available for `tsserver`. ------------------------------------------------------------------------------- 5.6 Symbol Search *ale-symbol-search* ALE supports searching for workspace symbols via LSP linters. The following commands are supported: |ALESymbolSearch| - Search for symbols in the workspace. Options: `-relative` Show file paths in the results relative to the working dir =============================================================================== 6. Global Options *ale-options* g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled* Type: |Number| Default: `1` Enables or disables the |airline|'s native extension for ale, which displays warnings and errors in the status line, prefixed by |airline#extensions#ale#error_symbol| and |airline#extensions#ale#warning_symbol|. g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures* Type: |Number| Default: undefined When set to `1`, ALE will cache failing executable checks for linters. By default, only executable checks which succeed will be cached. When this option is set to `1`, Vim will have to be restarted after new executables are installed for ALE to be able to run linters for those executables. g:ale_change_sign_column_color *g:ale_change_sign_column_color* Type: |Number| Default: `0` When set to `1`, this option will set different highlights for the sign column itself when ALE reports problems with a file. This option can be combined with |g:ale_sign_column_always|. ALE uses the following highlight groups for highlighting the sign column: `ALESignColumnWithErrors` - Links to `error` by default. `ALESignColumnWithoutErrors` - Uses the value for `SignColumn` by default. The sign column color can only be changed globally in Vim. The sign column might produce unexpected results if editing different files in split windows. g:ale_close_preview_on_insert *g:ale_close_preview_on_insert* Type: |Number| Default: `0` When this option is set to `1`, ALE's |preview-window| will be automatically closed upon entering Insert Mode. This option can be used in combination with |g:ale_cursor_detail| for automatically displaying the preview window on problem lines, and automatically closing it again when editing text. This setting must be set to `1` before ALE is loaded for this behavior to be enabled. See |ale-lint-settings-on-startup|. g:ale_command_wrapper *g:ale_command_wrapper* *b:ale_command_wrapper* Type: |String| Default: `''` An option for wrapping all commands that ALE runs, for linters, fixers, and LSP commands. This option can be set globally, or for specific buffers. This option can be used to apply nice to all commands. For example: > " Prefix all commands with nice. let g:ale_command_wrapper = 'nice -n5' < Use the |ALEInfo| command to view the commands that are run. All of the arguments for commands will be put on the end of the wrapped command by default. A `%*` marker can be used to spread the arguments in the wrapped command. > " Has the same effect as the above. let g:ale_command_wrapper = 'nice -n5 %*' < For passing all of the arguments for a command as one argument to a wrapper, `%@` can be used instead. > " Will result in say: /bin/bash -c 'other-wrapper -c "some command" -x' let g:ale_command_wrapper = 'other-wrapper -c %@ -x' < For commands including `&&` or `;`, only the last command in the list will be passed to the wrapper. `&&` is most commonly used in ALE to change the working directory before running a command. g:ale_completion_delay *g:ale_completion_delay* Type: |Number| Default: `100` The number of milliseconds before ALE will send a request to a language server for completions after you have finished typing. See |ale-completion| g:ale_completion_enabled *g:ale_completion_enabled* Type: |Number| Default: `0` When this option is set to `1`, completion support will be enabled. This setting must be set to `1` before ALE is loaded for this behavior to be enabled. See |ale-completion| g:ale_completion_excluded_words *g:ale_completion_excluded_words* *b:ale_completion_excluded_words* Type: |List| Default: `[]` This option can be set to a list of |String| values for "words" to exclude from completion results, as in the words for |complete-items|. The strings will be matched exactly in a case-sensitive manner. (|==#|) This setting can be configured in ftplugin files with buffer variables, so that different lists can be used for different filetypes. For example: > " In ~/.vim/ftplugin/typescript.vim " Don't suggest `it` or `describe` so we can use snippets for those words. let b:ale_completion_excluded_words = ['it', 'describe'] < g:ale_completion_max_suggestions *g:ale_completion_max_suggestions* Type: |Number| Default: `50` The maximum number of items ALE will suggest in completion menus for automatic completion. Setting this number higher will require more processing time, and may suggest too much noise. Setting this number lower will require less processing time, but some suggestions will not be included, so you might not be able to see the suggestions you want. Adjust this option as needed, depending on the complexity of your codebase and your available processing power. g:ale_cursor_detail *g:ale_cursor_detail* Type: |Number| Default: `0` When this option is set to `1`, ALE's |preview-window| will be automatically opened when the cursor moves onto lines with problems. ALE will search for problems using the same logic that |g:ale_echo_cursor| uses. The preview window will be closed automatically when you move away from the line. Messages are only displayed after a short delay. See |g:ale_echo_delay|. The preview window is opened without stealing focus, which means your cursor will stay in the same buffer as it currently is. The preview window can be closed automatically upon entering Insert mode by setting |g:ale_close_preview_on_insert| to `1`. Either this setting or |g:ale_echo_cursor| must be set to `1` before ALE is loaded for messages to be displayed. See |ale-lint-settings-on-startup|. g:ale_echo_cursor *g:ale_echo_cursor* Type: |Number| Default: `1` When this option is set to `1`, a truncated message will be echoed when a cursor is near a warning or error. ALE will attempt to find the warning or error at a column nearest to the cursor when the cursor is resting on a line which contains a warning or error. This option can be set to `0` to disable this behavior. Messages are only displayed after a short delay. See |g:ale_echo_delay|. The format of the message can be customized with |g:ale_echo_msg_format|. Either this setting or |g:ale_cursor_detail| must be set to `1` before ALE is loaded for messages to be displayed. See |ale-lint-settings-on-startup|. g:ale_echo_delay *g:ale_echo_delay* *b:ale_echo_delay* Type: |Number| Default: `10` Given any integer, this option controls the number of milliseconds before ALE will echo or preview a message for a problem near the cursor. The value can be increased to decrease the amount of processing ALE will do for files displaying a large number of problems. g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* Type: |String| Default: `'Error'` The string used for `%severity%` for errors. See |g:ale_echo_msg_format| g:ale_echo_msg_format *g:ale_echo_msg_format* b:ale_echo_msg_format *b:ale_echo_msg_format* Type: |String| Default: `'%code: %%s'` This variable defines a message format for echoed messages. The following sequences of characters will be replaced. `%s` - replaced with the text for the problem `%...code...% `- replaced with the error code `%linter%` - replaced with the name of the linter `%severity%` - replaced withe severity of the problem The strings for `%severity%` can be configured with the following options. |g:ale_echo_msg_error_str| - Defaults to `'Error'` |g:ale_echo_msg_info_str| - Defaults to `'Info'` |g:ale_echo_msg_warning_str| - Defaults to `'Warning'` `%code%` is replaced with the error code, and replaced with an empty string when there is no error code. Any extra characters between the percent signs will be printed when an error code is present. For example, a message like `(error code): message` will be printed for `'%(code): %%s'` and simply the message will be printed when there is no code. |g:ale_echo_cursor| needs to be set to 1 for messages to be displayed. The echo message format can also be configured separately for each buffer, so different formats can be used for differnt languages. (Say in ftplugin files.) g:ale_echo_msg_info_str *g:ale_echo_msg_info_str* Type: |String| Default: `'Info'` The string used for `%severity%` for info. See |g:ale_echo_msg_format| g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Type: |String| Default: `'Warning'` The string used for `%severity%` for warnings. See |g:ale_echo_msg_format| g:ale_enabled *g:ale_enabled* *b:ale_enabled* Type: |Number| Default: `1` When set to `0`, this option will completely disable ALE, such that no error checking will be performed, etc. ALE can be toggled on and off with the |ALEToggle| command, which changes this option. ALE can be disabled in each buffer by setting `let b:ale_enabled = 0` Disabling ALE based on filename patterns can be accomplished by setting a regular expression for |g:ale_pattern_options|. For example: > " Disable linting for all minified JS files. let g:ale_pattern_options = {'\.min.js$': {'ale_enabled': 0}} < See |g:ale_pattern_options| for more information on that option. g:ale_fixers *g:ale_fixers* *b:ale_fixers* Type: |Dictionary| Default: `{}` A mapping from filetypes to |List| values for functions for fixing errors. See |ale-fix| for more information. This variable can be overridden with variables in each buffer. `b:ale_fixers` can be set to a |List| of callbacks instead, which can be more convenient. A special `'*'` key be used as a wildcard filetype for configuring fixers for every other type of file. For example: > " Fix Python files with 'bar'. " Don't fix 'html' files. " Fix everything else with 'foo'. let g:ale_fixers = {'python': ['bar'], 'html': [], '*': ['foo']} < g:ale_fix_on_save *g:ale_fix_on_save* b:ale_fix_on_save *b:ale_fix_on_save* Type: |Number| Default: `0` When set to 1, ALE will fix files when they are saved. If |g:ale_lint_on_save| is set to 1, files will be checked with linters after files are fixed, only when the buffer is open, or re-opened. Changes to the file will be saved to the file on disk. Files will not be fixed on `:wq`, so you should check your code before closing a buffer. Fixing files can be disabled or enabled for individual buffers by setting `b:ale_fix_on_save` to `0` or `1`. g:ale_history_enabled *g:ale_history_enabled* Type: |Number| Default: `1` When set to `1`, ALE will remember the last few commands which were run for every buffer which is open. This information can be viewed with the |ALEInfo| command. The size of the buffer can be controlled with the |g:ale_max_buffer_history_size| option. This option can be disabled if storing a command history is not desired. g:ale_history_log_output *g:ale_history_log_output* Type: |Number| Default: `1` When set to `1`, ALE will store the output of commands which have completed successfully in the command history, and the output will be displayed when using |ALEInfo|. |g:ale_history_enabled| must be set to `1` for this output to be stored or printed. Some memory will be consumed by this option. It is very useful for figuring out what went wrong with linters, and for bug reports. Turn this option off if you want to save on some memory usage. g:ale_keep_list_window_open *g:ale_keep_list_window_open* *b:ale_keep_list_window_open* Type: |Number| Default: `0` When set to `1`, this option will keep the loclist or quickfix windows event after all warnings/errors have been removed for files. By default the loclist or quickfix windows will be closed automatically when there are no warnings or errors. See |g:ale_open_list| g:ale_list_window_size *g:ale_list_window_size* *b:ale_list_window_size* Type: |Number| Default: `10` This number configures the number of lines to set for the height of windows opened automatically for ALE problems. The default of `10` matches the Vim default height. See |g:ale_open_list| for information on automatically opening windows for quickfix or the loclist. g:ale_lint_delay *g:ale_lint_delay* Type: |Number| Default: `200` This variable controls the milliseconds delay after which the linters will be run after text is changed. This option is only meaningful with the |g:ale_lint_on_text_changed| variable set to `always`, `insert`, or `normal`. g:ale_lint_on_enter *g:ale_lint_on_enter* Type: |Number| Default: `1` When this option is set to `1`, the |BufWinEnter| event will be used to apply linters when buffers are first opened. If this is not desired, this variable can be set to `0` in your vimrc file to disable this behavior. The |FileChangedShellPost| and |BufEnter| events will be used to check if files have been changed outside of Vim. If a file is changed outside of Vim, it will be checked when it is next opened. You should set this setting once before ALE is loaded, and restart Vim if you want to change your preferences. See |ale-lint-settings-on-startup|. g:ale_lint_on_filetype_changed *g:ale_lint_on_filetype_changed* Type: |Number| Default: `1` This option will cause ALE to run when the filetype for a file is changed after a buffer has first been loaded. A short delay will be used before linting will be done, so the filetype can be changed quickly several times in a row, but resulting in only one lint cycle. You should set this setting once before ALE is loaded, and restart Vim if you want to change your preferences. See |ale-lint-settings-on-startup|. g:ale_lint_on_save *g:ale_lint_on_save* Type: |Number| Default: `1` This option will make ALE run the linters whenever a file is saved when it it set to `1` in your vimrc file. This option can be used in combination with the |g:ale_lint_on_enter| and |g:ale_lint_on_text_changed| options to make ALE only check files after that have been saved, if that is what is desired. g:ale_lint_on_text_changed *g:ale_lint_on_text_changed* Type: |String| Default: `'always'` This option controls how ALE will check your files as you make changes. The following values can be used. `'always'`, `'1'`, or `1` - Check buffers on |TextChanged| or |TextChangedI|. `'normal'` - Check buffers only on |TextChanged|. `'insert'` - Check buffers only on |TextChangedI|. `'never'`, `'0'`, or `0` - Never check buffers on changes. ALE will check buffers after a short delay, with a timer which resets on each change. The delay can be configured by adjusting the |g:ale_lint_delay| variable. *ale-linting-interrupts-mapping* Due to a bug in Vim, ALE can interrupt mappings with pending key presses, per |timeoutlen|. If this happens, follow the advice for enabling |g:ale_lint_on_insert_leave| below, and set this option to `'normal'`, or disable it entirely. You should set this setting once before ALE is loaded, and restart Vim if you want to change your preferences. See |ale-lint-settings-on-startup|. g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave* Type: |Number| Default: `0` When set to `1` in your vimrc file, this option will cause ALE to run linters when you leave insert mode. ALE will not lint files when you escape insert mode with |CTRL-C| by default. You can make ALE lint files with this option when you use |CTRL-C| with the following mapping. > " Make using Ctrl+C do the same as Escape, to trigger autocmd commands inoremap < You should set this setting once before ALE is loaded, and restart Vim if you want to change your preferences. See |ale-lint-settings-on-startup|. g:ale_linter_aliases *g:ale_linter_aliases* *b:ale_linter_aliases* Type: |Dictionary| Default: `{}` The |g:ale_linter_aliases| option can be used to set aliases from one filetype to another. A given filetype can be mapped to use the linters run for another given filetype. This |Dictionary| will be merged with a default dictionary containing the following values: > { \ 'Dockerfile': 'dockerfile', \ 'csh': 'sh', \ 'plaintex': 'tex', \ 'systemverilog': 'verilog', \ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'], \ 'vimwiki': 'markdown', \ 'vue': ['vue', 'javascript'], \ 'zsh': 'sh', \} < For example, if you wish to map a new filetype `'foobar'` to run the `'php'` linters, you could set the following: > let g:ale_linter_aliases = {'foobar': 'php'} < When combined with the |g:ale_linters| option, the original filetype (`'foobar'`) will be used for determining which linters to run, not the aliased type (`'php'`). This allows an aliased type to run a different set of linters from the type it is being mapped to. Passing a list of filetypes is also supported. Say you want to lint javascript and css embedded in HTML (using linters that support that). You could alias `html` like so: `let g:ale_linter_aliases = {'html': ['html', 'javascript', 'css']}` Note that `html` itself was included as an alias. That is because aliases will override the original linters for the aliased filetype. Linter aliases can be configured in each buffer with buffer-local variables. ALE will first look for aliases for filetypes in the `b:ale_linter_aliases` variable, then `g:ale_linter_aliases`, and then a default Dictionary. `b:ale_linter_aliases` can be set to a |List| or a |String|, to tell ALE to load the linters for specific filetypes for a given buffer. > let b:ale_linter_aliases = ['html', 'javascript', 'css'] " OR, Alias a filetype to only a single filetype with a String. let b:ale_linter_aliases = 'javascript' < No linters will be loaded when the buffer's filetype is empty. g:ale_linters *g:ale_linters* *b:ale_linters* Type: |Dictionary| Default: `{}` The |g:ale_linters| option sets a |Dictionary| mapping a filetype to a |List| of linter programs to be run when checking particular filetypes. This |Dictionary| will be merged with a default dictionary containing the following values: > { \ 'csh': ['shell'], \ 'elixir': ['credo', 'dialyxir', 'dogma'], \ 'go': ['gofmt', 'golint', 'go vet'], \ 'hack': ['hack'], \ 'help': [], \ 'perl': ['perlcritic'], \ 'perl6': [], \ 'python': ['flake8', 'mypy', 'pylint'], \ 'rust': ['cargo'], \ 'spec': [], \ 'text': [], \ 'vue': ['eslint', 'vls'], \ 'zsh': ['shell'], \} < This option can be used to enable only a particular set of linters for a file. For example, you can enable only `eslint` for JavaScript files: > let g:ale_linters = {'javascript': ['eslint']} < If you want to disable all linters for a particular filetype, you can pass an empty list of linters as the value: > let g:ale_linters = {'javascript': []} < All linters will be run for unspecified filetypes. All available linters can be enabled explicitly for a given filetype by passing the string `'all'`, instead of a List. > let g:ale_linters = {'c': 'all'} < Linters can be configured in each buffer with buffer-local variables. ALE will first look for linters for filetypes in the `b:ale_linters` variable, then `g:ale_linters`, and then the default Dictionary mentioned above. `b:ale_linters` can be set to a List, or the string `'all'`. When linters for two different filetypes share the same name, the first linter loaded will be used. Any ambiguity can be resolved by using a Dictionary specifying which linter to run for which filetype instead. > " Use ESLint for the buffer if the filetype includes 'javascript'. let b:ale_linters = {'javascript': ['eslint'], 'html': ['tidy']} " Use a List for the same setting. This will work in most cases. let b:ale_linters = ['eslint', 'tidy'] " Disable all linters for the buffer. let b:ale_linters = [] " Explicitly enable all available linters for the filetype. let b:ale_linters = 'all' < ALE can be configured to disable all linters unless otherwise specified with `g:ale_enabled` or `b:ale_enabled` with the option |g:ale_linters_explicit|. g:ale_linters_explicit *g:ale_linters_explicit* Type: |Number| Default: `0` When set to `1`, only the linters from |g:ale_linters| and |b:ale_linters| will be enabled. The default behavior for ALE is to enable as many linters as possible, unless otherwise specified. g:ale_linters_ignore *g:ale_linters_ignore* *b:ale_linters_ignore* Type: |Dictionary| or |List| Default: `{}` Linters to ignore. Commands for ignored linters will not be run, and diagnostics for LSP linters will be ignored. (See |ale-lsp|) This setting can be set to a |Dictionary| mapping filetypes to linter names, just like |g:ale_linters|, to list linters to ignore. Ignore lists will be applied after everything else. > " Select flake8 and pylint, and ignore pylint, so only flake8 is run. let g:ale_linters = {'python': ['flake8', 'pylint']} let g:ale_linters_ignore = {'python': ['pylint']} < This setting can be set to simply a |List| of linter names, which is especially more convenient when using the setting in ftplugin files for particular buffers. > " The same as above, in a ftplugin/python.vim. let b:ale_linters = ['flake8', 'pylint'] let b:ale_linters_ignore = ['pylint'] < g:ale_list_vertical *g:ale_list_vertical* *b:ale_list_vertical* Type: |Number| Default: `0` When set to `1`, this will cause ALE to open any windows (loclist or quickfix) vertically instead of horizontally (|vert| |lopen|) or (|vert| |copen|) g:ale_loclist_msg_format *g:ale_loclist_msg_format* b:ale_loclist_msg_format *b:ale_loclist_msg_format* Type: |String| Default: `g:ale_echo_msg_format` This option is the same as |g:ale_echo_msg_format|, but for formatting the message used for the loclist and the quickfix list. The strings for configuring `%severity%` are also used for this option. g:ale_lsp_root *g:ale_lsp_root* b:ale_lsp_root *b:ale_lsp_root* Type: |Dictionary| or |String| Default: {} This option is used to determine the project root for the LSP linter. If the value is a |Dictionary|, it maps a linter to either a string containing the project root or a |Funcref| to call to look up the root. The funcref is provided the buffer number as its argument. The buffer-specific variable may additionally be a string containing the project root itself. If neither variable yields a result, a linter-specific function is invoked to detect a project root. If this, too, yields no result, the linter is disabled. g:ale_max_buffer_history_size *g:ale_max_buffer_history_size* Type: |Number| Default: `20` This setting controls the maximum number of commands which will be stored in the command history used for |ALEInfo|. Command history will be rotated in a FIFO manner. If set to a number <= 0, then the history will be continuously set to an empty |List|. History can be disabled completely with |g:ale_history_enabled|. g:ale_max_signs *g:ale_max_signs* *b:ale_max_signs* Type: |Number| Default: `-1` When set to any positive integer, ALE will not render any more than the given number of signs for any one buffer. When set to `0`, no signs will be set, but sign processing will still be done, so existing signs can be removed. When set to any other value, no limit will be imposed on the number of signs set. For disabling sign processing, see |g:ale_set_signs|. g:ale_maximum_file_size *g:ale_maximum_file_size* *b:ale_maximum_file_size* Type: |Number| Default: undefined A maximum file size in bytes for ALE to check. If set to any positive number, ALE will skip checking files larger than the given size. g:ale_open_list *g:ale_open_list* *b:ale_open_list* Type: |Number| or |String| Default: `0` When set to `1`, this will cause ALE to automatically open a window for the loclist (|lopen|) or for the quickfix list instead if |g:ale_set_quickfix| is `1`. (|copen|) When set to `'on_save'`, ALE will only open the loclist after buffers have been saved. The list will be opened some time after buffers are saved and any linter for a buffer returns results. The window will be kept open until all warnings or errors are cleared, including those not set by ALE, unless |g:ale_keep_list_window_open| is set to `1`, in which case the window will be kept open when no problems are found. The window size can be configured with |g:ale_list_window_size|. Windows can be opened vertically with |g:ale_list_vertical|. If you want to close the loclist window automatically when the buffer is closed, you can set up the following |autocmd| command: > augroup CloseLoclistWindowGroup autocmd! autocmd QuitPre * if empty(&buftype) | lclose | endif augroup END < g:ale_pattern_options *g:ale_pattern_options* Type: |Dictionary| Default: undefined This option maps regular expression patterns to |Dictionary| values for buffer variables. This option can be set to automatically configure different settings for different files. For example: > " Use just ESLint for linting and fixing files which end in '.foo.js' let g:ale_pattern_options = { \ '\.foo\.js$': { \ 'ale_linters': ['eslint'], \ 'ale_fixers': ['eslint'], \ }, \} < See |b:ale_linters| and |b:ale_fixers| for information for those options. Filenames are matched with |match()|, and patterns depend on the |magic| setting, unless prefixed with the special escape sequences like `'\v'`, etc. The patterns can match any part of a filename. The absolute path of the filename will be used for matching, taken from `expand('%:p')`. The options for every match for the filename will be applied, with the pattern keys sorted in alphabetical order. Options for `'zebra'` will override the options for `'alpha'` for a filename `alpha-zebra`. g:ale_pattern_options_enabled *g:ale_pattern_options_enabled* Type: |Number| Default: undefined This option can be used for disabling pattern options. If set to `0`, ALE will not set buffer variables per |g:ale_pattern_options|. g:ale_set_balloons *g:ale_set_balloons* *b:ale_set_balloons* Type: |Number| Default: `has('balloon_eval') && has('gui_running')` When this option is set to `1`, balloon messages will be displayed for problems or hover information if available. Problems nearest to the line the mouse cursor is over will be displayed. If there are no problems to show, and one of the linters is an LSP linter supporting "Hover" information, per |ale-hover|, then brief information about the symbol under the cursor will be displayed in a balloon. Balloons can be enabled for terminal versions of Vim that support balloons, but some versions of Vim will produce strange mouse behavior when balloons are enabled. To configure balloons for your terminal, you should first configure your |ttymouse| setting, and then consider setting `g:ale_set_balloons` to `1` before ALE is loaded. `b:ale_set_balloons` can be set to `0` to disable balloons for a buffer. Balloons cannot be enabled for a specific buffer when not initially enabled globally. Balloons will not be shown when |g:ale_enabled| or |b:ale_enabled| is `0`. g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo* *b:ale_set_balloons_legacy_echo* Type: |Number| Default: undefined If set to `1`, moving your mouse over documents in Vim will make ALE ask `tsserver` or `LSP` servers for information about the symbol where the mouse cursor is, and print that information into Vim's echo line. This is an option for supporting older versions of Vim which do not properly support balloons in an asynchronous manner. If your version of Vim supports the |balloon_show| function, then this option does nothing meaningful. g:ale_set_highlights *g:ale_set_highlights* Type: |Number| Default: `has('syntax')` When this option is set to `1`, highlights will be set for problems. ALE will use the following highlight groups for problems: |ALEError| - Items with `'type': 'E'` |ALEWarning| - Items with `'type': 'W'` |ALEInfo.| - Items with `'type': 'I'` |ALEStyleError| - Items with `'type': 'E'` and `'sub_type': 'style'` |ALEStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'` When |g:ale_set_signs| is set to `0`, the following highlights for entire lines will be set. |ALEErrorLine| - All items with `'type': 'E'` |ALEWarningLine| - All items with `'type': 'W'` |ALEInfoLine| - All items with `'type': 'I'` Vim can only highlight the characters up to the last column in a buffer for match highlights, whereas the line highlights when signs are enabled will run to the edge of the screen. g:ale_set_loclist *g:ale_set_loclist* Type: |Number| Default: `1` When this option is set to `1`, the |loclist| will be populated with any warnings and errors which are found by ALE. This feature can be used to implement jumping between errors through typical use of |lnext| and |lprev|. g:ale_set_quickfix *g:ale_set_quickfix* Type: |Number| Default: `0` When this option is set to `1`, the |quickfix| list will be populated with any problems which are found by ALE, instead of the |loclist|. The loclist will never be populated when this option is on. Problems from every buffer ALE has checked will be included in the quickfix list, which can be checked with |:copen|. Problems will be de-duplicated. This feature should not be used in combination with tools for searching for matches and commands like |:cfdo|, as ALE will replace the quickfix list pretty frequently. If you wish to use such tools, you should populate the loclist instead. g:ale_set_signs *g:ale_set_signs* Type: |Number| Default: `has('signs')` When this option is set to `1`, the |sign| column will be populated with signs marking where problems appear in the file. ALE will use the following highlight groups for problems: |ALEErrorSign| - Items with `'type': 'E'` |ALEWarningSign| - Items with `'type': 'W'` |ALEInfoSign| - Items with `'type': 'I'` |ALEStyleErrorSign| - Items with `'type': 'E'` and `'sub_type': 'style'` |ALEStyleWarningSign| - Items with `'type': 'W'` and `'sub_type': 'style'` In addition to the style of the signs, the style of lines where signs appear can be configured with the following highlights: |ALEErrorLine| - All items with `'type': 'E'` |ALEWarningLine| - All items with `'type': 'W'` |ALEInfoLine| - All items with `'type': 'I'` The markers for the highlights can be customized with the following options: |g:ale_sign_error| |g:ale_sign_warning| |g:ale_sign_info| |g:ale_sign_style_error| |g:ale_sign_style_warning| When multiple problems exist on the same line, the signs will take precedence in the order above, from highest to lowest. To limit the number of signs ALE will set, see |g:ale_max_signs|. g:ale_shell *g:ale_shell* Type: |String| Default: not set Override the shell used by ALE for executing commands. ALE uses 'shell' by default, but falls back in `/bin/sh` if the default shell looks like `fish` or `pwsh`, which are not compatible with all of the commands run by ALE. The shell specified with this option will be used even if it might not work in all cases. For Windows, ALE uses `cmd` when this option isn't set. Setting this option will apply shell escaping to the command string, even on Windows. NOTE: Consider setting |g:ale_shell_arguments| if this option is defined. g:ale_shell_arguments *g:ale_shell_arguments* Type: |String| Default: not set This option specifies the arguments to use for executing a command with a custom shell, per |g:ale_shell|. If this option is not set, 'shellcmdflag' will be used instead. g:ale_sign_column_always *g:ale_sign_column_always* Type: |Number| Default: `0` By default, the sign gutter will disappear when all warnings and errors have been fixed for a file. When this option is set to `1`, the sign column will remain open. This can be preferable if you don't want the text in your file to move around as you edit a file. g:ale_sign_error *g:ale_sign_error* Type: |String| Default: `'>>'` The sign for errors in the sign gutter. g:ale_sign_info *g:ale_sign_info* Type: |String| Default: `g:ale_sign_warning` The sign for "info" markers in the sign gutter. g:ale_sign_style_error *g:ale_sign_style_error* Type: |String| Default: `g:ale_sign_error` The sign for style errors in the sign gutter. g:ale_sign_style_warning *g:ale_sign_style_warning* Type: |String| Default: `g:ale_sign_warning` The sign for style warnings in the sign gutter. g:ale_sign_offset *g:ale_sign_offset* Type: |Number| Default: `1000000` This variable controls offset from which numeric IDs will be generated for new signs. Signs cannot share the same ID values, so when two Vim plugins set signs at the same time, the IDs have to be configured such that they do not conflict with one another. If the IDs used by ALE are found to conflict with some other plugin, this offset value can be changed, and hopefully both plugins will work together. See |sign-place| for more information on how signs are set. g:ale_sign_warning *g:ale_sign_warning* Type: |String| Default: `'--'` The sign for warnings in the sign gutter. g:ale_type_map *g:ale_type_map* *b:ale_type_map* Type: |Dictionary| Default: `{}` This option can be set re-map problem types for linters. Each key in the |Dictionary| should be the name of a linter, and each value must be a |Dictionary| mapping problem types from one type to another. The following types are supported: `'E'` - `{'type': 'E'}` `'ES'` - `{'type': 'E', 'sub_type': 'style'}` `'W'` - `{'type': 'W'}` `'WS'` - `{'type': 'W', 'sub_type': 'style'}` `'I'` - `{'type': 'I'}` For example, if you want to turn flake8 errors into warnings, you can write the following: > let g:ale_type_map = {'flake8': {'ES': 'WS', 'E': 'W'}} < If you wanted to turn style errors and warnings into regular errors and warnings, you can write the following: > let g:ale_type_map = {'flake8': {'ES': 'E', 'WS': 'W'}} < Type maps can be set per-buffer with `b:ale_type_map`. g:ale_use_global_executables *g:ale_use_global_executables* Type: |Number| Default: not set This option can be set to change the default for all `_use_global` options. This option must be set before ALE is loaded, preferably in a vimrc file. See |ale-integrations-local-executables| for more information on those options. g:ale_virtualtext_cursor *g:ale_virtualtext_cursor* Type: |Number| Default: `0` When this option is set to `1`, a message will be shown when a cursor is near a warning or error. ALE will attempt to find the warning or error at a column nearest to the cursor when the cursor is resting on a line which contains a warning or error. This option can be set to `0` to disable this behavior. Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|. Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|. ALE will use the following highlight groups for problems: |ALEVirtualTextError| - Items with `'type': 'E'` |ALEVirtualTextWarning| - Items with `'type': 'W'` |ALEVirtualTextInfo| - Items with `'type': 'I'` |ALEVirtualTextStyleError| - Items with `'type': 'E'` and `'sub_type': 'style'` |ALEVirtualTextStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'` g:ale_virtualtext_delay *g:ale_virtualtext_delay* b:ale_virtualtext_delay *b:ale_virtualtext_delay* Type: |Number| Default: `10` Given any integer, this option controls the number of milliseconds before ALE will show a message for a problem near the cursor. The value can be increased to decrease the amount of processing ALE will do for files displaying a large number of problems. g:ale_virtualtext_prefix *g:ale_virtualtext_prefix* Type: |String| Default: `'> '` Prefix to be used with |g:ale_virtualtext_cursor|. g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names* b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names* Type: |List| Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']` A list of directory names to be used when searching upwards from Python files to discover virtulenv directories with. For directory named `'foo'`, ALE will search for `'foo/bin/activate'` (`foo\Scripts\activate\` on Windows) in all directories on and above the directory containing the Python file to find virtualenv paths. g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines* b:ale_warn_about_trailing_blank_lines *b:ale_warn_about_trailing_blank_lines* Type: |Number| Default: `1` When this option is set to `1`, warnings about trailing blank lines will be shown. This option behaves similarly to |g:ale_warn_about_trailing_whitespace|. g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace* b:ale_warn_about_trailing_whitespace *b:ale_warn_about_trailing_whitespace* Type: |Number| Default: `1` When this option is set to `1`, warnings relating to trailing whitespace on lines will be shown. If warnings are too irritating while editing buffers, and you have configured Vim to automatically remove trailing whitespace, you can disable these warnings by setting this option to `0`. Not all linters may respect this option. If a linter does not, please file a bug report, and it may be possible to add such support. This option may be configured on a per buffer basis. g:ale_windows_node_executable_path *g:ale_windows_node_executable_path* *b:ale_windows_node_executable_path* Type: |String| Default: `'node.exe'` This variable is used as the path to the executable to use for executing scripts with Node.js on Windows. For Windows, any file with a `.js` file extension needs to be executed with the node executable explicitly. Otherwise, Windows could try and open the scripts with other applications, like a text editor. Therefore, these scripts are executed with whatever executable is configured with this setting. ------------------------------------------------------------------------------- 6.1. Highlights *ale-highlights* ALEError *ALEError* Default: `highlight link ALEError SpellBad` The highlight for highlighted errors. See |g:ale_set_highlights|. ALEErrorLine *ALEErrorLine* Default: Undefined The highlight for an entire line where errors appear. Only the first line for a problem will be highlighted. See |g:ale_set_signs| and |g:ale_set_highlights|. ALEErrorSign *ALEErrorSign* Default: `highlight link ALEErrorSign error` The highlight for error signs. See |g:ale_set_signs|. ALEInfo *ALEInfo.* *ALEInfo-highlight* Default: `highlight link ALEInfo ALEWarning` The highlight for highlighted info messages. See |g:ale_set_highlights|. ALEInfoSign *ALEInfoSign* Default: `highlight link ALEInfoSign ALEWarningSign` The highlight for info message signs. See |g:ale_set_signs|. ALEInfoLine *ALEInfoLine* Default: Undefined The highlight for entire lines where info messages appear. Only the first line for a problem will be highlighted. See |g:ale_set_signs| and |g:ale_set_highlights|. ALEStyleError *ALEStyleError* Default: `highlight link ALEStyleError ALEError` The highlight for highlighted style errors. See |g:ale_set_highlights|. ALEStyleErrorSign *ALEStyleErrorSign* Default: `highlight link ALEStyleErrorSign ALEErrorSign` The highlight for style error signs. See |g:ale_set_signs|. ALEStyleWarning *ALEStyleWarning* Default: `highlight link ALEStyleWarning ALEError` The highlight for highlighted style warnings. See |g:ale_set_highlights|. ALEStyleWarningSign *ALEStyleWarningSign* Default: `highlight link ALEStyleWarningSign ALEWarningSign` The highlight for style warning signs. See |g:ale_set_signs|. ALEVirtualTextError *ALEVirtualTextError* Default: `highlight link ALEVirtualTextError ALEError` The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|. ALEVirtualTextInfo *ALEVirtualTextInfo* Default: `highlight link ALEVirtualTextInfo ALEVirtualTextWarning` The highlight for virtualtext info. See |g:ale_virtualtext_cursor|. ALEVirtualTextStyleError *ALEVirtualTextStyleError* Default: `highlight link ALEVirtualTextStyleError ALEVirtualTextError` The highlight for virtualtext style errors. See |g:ale_virtualtext_cursor|. ALEVirtualTextStyleWarning *ALEVirtualTextStyleWarning* Default: `highlight link ALEVirtualTextStyleWarning ALEVirtualTextWarning` The highlight for virtualtext style warnings. See |g:ale_virtualtext_cursor|. ALEVirtualTextWarning *ALEVirtualTextWarning* Default: `highlight link ALEVirtualTextWarning ALEWarning` The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|. ALEWarning *ALEWarning* Default: `highlight link ALEWarning SpellCap` The highlight for highlighted warnings. See |g:ale_set_highlights|. ALEWarningLine *ALEWarningLine* Default: Undefined The highlight for entire lines where warnings appear. Only the first line for a problem will be highlighted. See |g:ale_set_signs| and |g:ale_set_highlights|. ALEWarningSign *ALEWarningSign* Default: `highlight link ALEWarningSign todo` The highlight for warning signs. See |g:ale_set_signs|. =============================================================================== 7. Linter/Fixer Options *ale-integration-options* Linter and fixer options are documented below and in individual help files. Every option for programs can be set globally, or individually for each buffer. For example, `b:ale_python_flake8_executable` will override any values set for `g:ale_python_flake8_executable`. *ale-integrations-local-executables* Some tools will prefer to search for locally-installed executables, unless configured otherwise. For example, the `eslint` linter will search for various executable paths in `node_modules`. The `flake8` linter will search for virtualenv directories. If you prefer to use global executables for those tools, set the relevant `_use_global` and `_executable` options for those linters. > " Use the global executable with a special name for eslint. let g:ale_javascript_eslint_executable = 'special-eslint' let g:ale_javascript_eslint_use_global = 1 " Use the global executable with a special name for flake8. let g:ale_python_flake8_executable = '/foo/bar/flake8' let g:ale_python_flake8_use_global = 1 < |g:ale_use_global_executables| can be set to `1` in your vimrc file to make ALE use global executables for all linters by default. The option |g:ale_virtualenv_dir_names| controls the local virtualenv paths ALE will use to search for Python executables. ------------------------------------------------------------------------------- 7.1. Options for alex *ale-alex-options* The options for `alex` are shared between all filetypes, so options can be configured once. g:ale_alex_executable *g:ale_alex_executable* *b:ale_alex_executable* Type: |String| Default: `'alex'` See |ale-integrations-local-executables| g:ale_alex_use_global *g:ale_alex_use_global* *b:ale_alex_use_global* Type: |Number| Default: `get(g:, 'ale_use_global_executables', 0)` See |ale-integrations-local-executables| ------------------------------------------------------------------------------- 7.2. Options for languagetool *ale-languagetool-options* g:ale_languagetool_executable *g:ale_languagetool_executable* *b:ale_languagetool_executable* Type: |String| Default: `'languagetool'` The executable to run for languagetool. ------------------------------------------------------------------------------- 7.3. Options for write-good *ale-write-good-options* The options for `write-good` are shared between all filetypes, so options can be configured once. g:ale_writegood_executable *g:ale_writegood_executable* *b:ale_writegood_executable* Type: |String| Default: `'writegood'` See |ale-integrations-local-executables| g:ale_writegood_options *g:ale_writegood_options* *b:ale_writegood_options* Type: |String| Default: `''` This variable can be set to pass additional options to writegood. g:ale_writegood_use_global *g:ale_writegood_use_global* *b:ale_writegood_use_global* Type: |Number| Default: `get(g:, 'ale_use_global_executables', 0)` See |ale-integrations-local-executables| ------------------------------------------------------------------------------- 7.4. Other Linter/Fixer Options *ale-other-integration-options* ALE supports a very wide variety of tools. Other linter or fixer options are documented in additional help files. ada.....................................|ale-ada-options| gcc...................................|ale-ada-gcc| ansible.................................|ale-ansible-options| ansible-lint..........................|ale-ansible-ansible-lint| asciidoc................................|ale-asciidoc-options| write-good............................|ale-asciidoc-write-good| textlint..............................|ale-asciidoc-textlint| asm.....................................|ale-asm-options| gcc...................................|ale-asm-gcc| awk.....................................|ale-awk-options| gawk..................................|ale-awk-gawk| bib.....................................|ale-bib-options| bibclean..............................|ale-bib-bibclean| c.......................................|ale-c-options| clang.................................|ale-c-clang| clangd................................|ale-c-clangd| clang-format..........................|ale-c-clangformat| clangtidy.............................|ale-c-clangtidy| cppcheck..............................|ale-c-cppcheck| cquery................................|ale-c-cquery| flawfinder............................|ale-c-flawfinder| gcc...................................|ale-c-gcc| uncrustify............................|ale-c-uncrustify| ccls..................................|ale-c-ccls| chef....................................|ale-chef-options| foodcritic............................|ale-chef-foodcritic| clojure.................................|ale-clojure-options| joker.................................|ale-clojure-joker| cloudformation..........................|ale-cloudformation-options| cfn-python-lint.......................|ale-cloudformation-cfn-python-lint| cmake...................................|ale-cmake-options| cmakelint.............................|ale-cmake-cmakelint| cmake-format..........................|ale-cmake-cmakeformat| cpp.....................................|ale-cpp-options| clang.................................|ale-cpp-clang| clangd................................|ale-cpp-clangd| clangcheck............................|ale-cpp-clangcheck| clang-format..........................|ale-cpp-clangformat| clangtidy.............................|ale-cpp-clangtidy| clazy.................................|ale-cpp-clazy| cppcheck..............................|ale-cpp-cppcheck| cpplint...............................|ale-cpp-cpplint| cquery................................|ale-cpp-cquery| flawfinder............................|ale-cpp-flawfinder| gcc...................................|ale-cpp-gcc| uncrustify............................|ale-cpp-uncrustify| ccls..................................|ale-cpp-ccls| c#......................................|ale-cs-options| mcs...................................|ale-cs-mcs| mcsc..................................|ale-cs-mcsc| uncrustify............................|ale-cs-uncrustify| css.....................................|ale-css-options| prettier..............................|ale-css-prettier| stylelint.............................|ale-css-stylelint| cuda....................................|ale-cuda-options| nvcc..................................|ale-cuda-nvcc| clang-format..........................|ale-cuda-clangformat| d.......................................|ale-d-options| dls...................................|ale-d-dls| uncrustify............................|ale-d-uncrustify| dart....................................|ale-dart-options| dartanalyzer..........................|ale-dart-dartanalyzer| dartfmt...............................|ale-dart-dartfmt| dockerfile..............................|ale-dockerfile-options| dockerfile_lint.......................|ale-dockerfile-dockerfile_lint| hadolint..............................|ale-dockerfile-hadolint| elixir..................................|ale-elixir-options| mix...................................|ale-elixir-mix| mix_format............................|ale-elixir-mix-format| dialyxir..............................|ale-elixir-dialyxir| elixir-ls.............................|ale-elixir-elixir-ls| credo.................................|ale-elixir-credo| elm.....................................|ale-elm-options| elm-format............................|ale-elm-elm-format| elm-lsp...............................|ale-elm-elm-lsp| elm-make..............................|ale-elm-elm-make| erlang..................................|ale-erlang-options| erlc..................................|ale-erlang-erlc| syntaxerl.............................|ale-erlang-syntaxerl| eruby...................................|ale-eruby-options| ruumba................................|ale-eruby-ruumba| fish....................................|ale-fish-options| fortran.................................|ale-fortran-options| gcc...................................|ale-fortran-gcc| language_server.......................|ale-fortran-language-server| fountain................................|ale-fountain-options| fusionscript............................|ale-fuse-options| fusion-lint...........................|ale-fuse-fusionlint| git commit..............................|ale-gitcommit-options| gitlint...............................|ale-gitcommit-gitlint| glsl....................................|ale-glsl-options| glslang...............................|ale-glsl-glslang| glslls................................|ale-glsl-glslls| go......................................|ale-go-options| gobuild...............................|ale-go-gobuild| gofmt.................................|ale-go-gofmt| golint................................|ale-go-golint| govet.................................|ale-go-govet| gometalinter..........................|ale-go-gometalinter| staticcheck...........................|ale-go-staticcheck| golangserver..........................|ale-go-golangserver| golangci-lint.........................|ale-go-golangci-lint| bingo.................................|ale-go-bingo| graphql.................................|ale-graphql-options| eslint................................|ale-graphql-eslint| gqlint................................|ale-graphql-gqlint| prettier..............................|ale-graphql-prettier| hack....................................|ale-hack-options| hack..................................|ale-hack-hack| hackfmt...............................|ale-hack-hackfmt| hhast.................................|ale-hack-hhast| handlebars..............................|ale-handlebars-options| ember-template-lint...................|ale-handlebars-embertemplatelint| haskell.................................|ale-haskell-options| brittany..............................|ale-haskell-brittany| ghc...................................|ale-haskell-ghc| ghc-mod...............................|ale-haskell-ghc-mod| cabal-ghc.............................|ale-haskell-cabal-ghc| hdevtools.............................|ale-haskell-hdevtools| hfmt..................................|ale-haskell-hfmt| hlint.................................|ale-haskell-hlint| stack-build...........................|ale-haskell-stack-build| stack-ghc.............................|ale-haskell-stack-ghc| stylish-haskell.......................|ale-haskell-stylish-haskell| hie...................................|ale-haskell-hie| hcl.....................................|ale-hcl-options| terraform-fmt.........................|ale-hcl-terraform-fmt| html....................................|ale-html-options| htmlhint..............................|ale-html-htmlhint| tidy..................................|ale-html-tidy| prettier..............................|ale-html-prettier| stylelint.............................|ale-html-stylelint| write-good............................|ale-html-write-good| idris...................................|ale-idris-options| idris.................................|ale-idris-idris| ispc....................................|ale-ispc-options| ispc..................................|ale-ispc-ispc| java....................................|ale-java-options| checkstyle............................|ale-java-checkstyle| javac.................................|ale-java-javac| google-java-format....................|ale-java-google-java-format| pmd...................................|ale-java-pmd| javalsp...............................|ale-java-javalsp| uncrustify............................|ale-java-uncrustify| javascript..............................|ale-javascript-options| eslint................................|ale-javascript-eslint| flow..................................|ale-javascript-flow| importjs..............................|ale-javascript-importjs| jscs..................................|ale-javascript-jscs| jshint................................|ale-javascript-jshint| prettier..............................|ale-javascript-prettier| prettier-eslint.......................|ale-javascript-prettier-eslint| prettier-standard.....................|ale-javascript-prettier-standard| standard..............................|ale-javascript-standard| xo....................................|ale-javascript-xo| json....................................|ale-json-options| fixjson...............................|ale-json-fixjson| jsonlint..............................|ale-json-jsonlint| jq....................................|ale-json-jq| prettier..............................|ale-json-prettier| julia...................................|ale-julia-options| languageserver........................|ale-julia-languageserver| kotlin..................................|ale-kotlin-options| kotlinc...............................|ale-kotlin-kotlinc| ktlint................................|ale-kotlin-ktlint| languageserver........................|ale-kotlin-languageserver| latex...................................|ale-latex-options| write-good............................|ale-latex-write-good| textlint..............................|ale-latex-textlint| less....................................|ale-less-options| lessc.................................|ale-less-lessc| prettier..............................|ale-less-prettier| stylelint.............................|ale-less-stylelint| llvm....................................|ale-llvm-options| llc...................................|ale-llvm-llc| lua.....................................|ale-lua-options| luac..................................|ale-lua-luac| luacheck..............................|ale-lua-luacheck| markdown................................|ale-markdown-options| mdl...................................|ale-markdown-mdl| prettier..............................|ale-markdown-prettier| remark-lint...........................|ale-markdown-remark-lint| textlint..............................|ale-markdown-textlint| write-good............................|ale-markdown-write-good| mercury.................................|ale-mercury-options| mmc...................................|ale-mercury-mmc| nasm....................................|ale-nasm-options| nasm..................................|ale-nasm-nasm| nroff...................................|ale-nroff-options| write-good............................|ale-nroff-write-good| objc....................................|ale-objc-options| clang.................................|ale-objc-clang| clangd................................|ale-objc-clangd| uncrustify............................|ale-objc-uncrustify| ccls..................................|ale-objc-ccls| objcpp..................................|ale-objcpp-options| clang.................................|ale-objcpp-clang| clangd................................|ale-objcpp-clangd| uncrustify............................|ale-objcpp-uncrustify| ocaml...................................|ale-ocaml-options| merlin................................|ale-ocaml-merlin| ols...................................|ale-ocaml-ols| ocamlformat...........................|ale-ocaml-ocamlformat| pawn....................................|ale-pawn-options| uncrustify............................|ale-pawn-uncrustify| perl....................................|ale-perl-options| perl..................................|ale-perl-perl| perlcritic............................|ale-perl-perlcritic| perltidy..............................|ale-perl-perltidy| perl6...................................|ale-perl6-options| perl6.................................|ale-perl6-perl6| php.....................................|ale-php-options| langserver............................|ale-php-langserver| phan..................................|ale-php-phan| phpcbf................................|ale-php-phpcbf| phpcs.................................|ale-php-phpcs| phpmd.................................|ale-php-phpmd| phpstan...............................|ale-php-phpstan| psalm.................................|ale-php-psalm| php-cs-fixer..........................|ale-php-php-cs-fixer| php...................................|ale-php-php| po......................................|ale-po-options| write-good............................|ale-po-write-good| pod.....................................|ale-pod-options| write-good............................|ale-pod-write-good| pony....................................|ale-pony-options| ponyc.................................|ale-pony-ponyc| prolog..................................|ale-prolog-options| swipl.................................|ale-prolog-swipl| proto...................................|ale-proto-options| protoc-gen-lint.......................|ale-proto-protoc-gen-lint| pug.....................................|ale-pug-options| puglint...............................|ale-pug-puglint| puppet..................................|ale-puppet-options| puppet................................|ale-puppet-puppet| puppetlint............................|ale-puppet-puppetlint| puppet-languageserver.................|ale-puppet-languageserver| pyrex (cython)..........................|ale-pyrex-options| cython................................|ale-pyrex-cython| python..................................|ale-python-options| autopep8..............................|ale-python-autopep8| bandit................................|ale-python-bandit| black.................................|ale-python-black| flake8................................|ale-python-flake8| isort.................................|ale-python-isort| mypy..................................|ale-python-mypy| prospector............................|ale-python-prospector| pycodestyle...........................|ale-python-pycodestyle| pydocstyle............................|ale-python-pydocstyle| pyflakes..............................|ale-python-pyflakes| pylama................................|ale-python-pylama| pylint................................|ale-python-pylint| pyls..................................|ale-python-pyls| pyre..................................|ale-python-pyre| vulture...............................|ale-python-vulture| yapf..................................|ale-python-yapf| qml.....................................|ale-qml-options| qmlfmt................................|ale-qml-qmlfmt| r.......................................|ale-r-options| lintr.................................|ale-r-lintr| reasonml................................|ale-reasonml-options| merlin................................|ale-reasonml-merlin| ols...................................|ale-reasonml-ols| refmt.................................|ale-reasonml-refmt| restructuredtext........................|ale-restructuredtext-options| textlint..............................|ale-restructuredtext-textlint| write-good............................|ale-restructuredtext-write-good| ruby....................................|ale-ruby-options| brakeman..............................|ale-ruby-brakeman| rails_best_practices..................|ale-ruby-rails_best_practices| reek..................................|ale-ruby-reek| rubocop...............................|ale-ruby-rubocop| ruby..................................|ale-ruby-ruby| rufo..................................|ale-ruby-rufo| solargraph............................|ale-ruby-solargraph| standardrb............................|ale-ruby-standardrb| rust....................................|ale-rust-options| cargo.................................|ale-rust-cargo| rls...................................|ale-rust-rls| rustc.................................|ale-rust-rustc| rustfmt...............................|ale-rust-rustfmt| sass....................................|ale-sass-options| sasslint..............................|ale-sass-sasslint| stylelint.............................|ale-sass-stylelint| scala...................................|ale-scala-options| sbtserver.............................|ale-scala-sbtserver| scalafmt..............................|ale-scala-scalafmt| scalastyle............................|ale-scala-scalastyle| scss....................................|ale-scss-options| prettier..............................|ale-scss-prettier| sasslint..............................|ale-scss-sasslint| stylelint.............................|ale-scss-stylelint| sh......................................|ale-sh-options| sh-language-server....................|ale-sh-language-server| shell.................................|ale-sh-shell| shellcheck............................|ale-sh-shellcheck| shfmt.................................|ale-sh-shfmt| sml.....................................|ale-sml-options| smlnj.................................|ale-sml-smlnj| solidity................................|ale-solidity-options| solhint...............................|ale-solidity-solhint| solium................................|ale-solidity-solium| spec....................................|ale-spec-options| rpmlint...............................|ale-spec-rpmlint| sql.....................................|ale-sql-options| sqlfmt................................|ale-sql-sqlfmt| stylus..................................|ale-stylus-options| stylelint.............................|ale-stylus-stylelint| sugarss.................................|ale-sugarss-options| stylelint.............................|ale-sugarss-stylelint| tcl.....................................|ale-tcl-options| nagelfar..............................|ale-tcl-nagelfar| terraform...............................|ale-terraform-options| fmt...................................|ale-terraform-fmt| tflint................................|ale-terraform-tflint| tex.....................................|ale-tex-options| chktex................................|ale-tex-chktex| lacheck...............................|ale-tex-lacheck| texinfo.................................|ale-texinfo-options| write-good............................|ale-texinfo-write-good| text....................................|ale-text-options| textlint..............................|ale-text-textlint| write-good............................|ale-text-write-good| thrift..................................|ale-thrift-options| thrift................................|ale-thrift-thrift| typescript..............................|ale-typescript-options| eslint................................|ale-typescript-eslint| prettier..............................|ale-typescript-prettier| tslint................................|ale-typescript-tslint| tsserver..............................|ale-typescript-tsserver| vala....................................|ale-vala-options| uncrustify............................|ale-vala-uncrustify| verilog/systemverilog...................|ale-verilog-options| iverilog..............................|ale-verilog-iverilog| verilator.............................|ale-verilog-verilator| vlog..................................|ale-verilog-vlog| xvlog.................................|ale-verilog-xvlog| vhdl....................................|ale-vhdl-options| ghdl..................................|ale-vhdl-ghdl| vcom..................................|ale-vhdl-vcom| xvhdl.................................|ale-vhdl-xvhdl| vim.....................................|ale-vim-options| vint..................................|ale-vim-vint| vim help................................|ale-vim-help-options| write-good............................|ale-vim-help-write-good| vue.....................................|ale-vue-options| prettier..............................|ale-vue-prettier| vls...................................|ale-vue-vls| xhtml...................................|ale-xhtml-options| write-good............................|ale-xhtml-write-good| xml.....................................|ale-xml-options| xmllint...............................|ale-xml-xmllint| yaml....................................|ale-yaml-options| prettier..............................|ale-yaml-prettier| swaglint..............................|ale-yaml-swaglint| yamllint..............................|ale-yaml-yamllint| yang....................................|ale-yang-options| yang-lsp..............................|ale-yang-lsp| =============================================================================== 8. Commands/Keybinds *ale-commands* ALEComplete *ALEComplete* Manually trigger LSP autocomplete and show the menu. Works only when called from insert mode. > inoremap :AleComplete < A plug mapping `(ale_complete)` is defined for this command. > imap (ale_complete) < ALEDocumentation *ALEDocumentation* Similar to the |ALEHover| command, retrieve documentation information for the symbol at the cursor. Documentation data will always be shown in a preview window, no matter how small the documentation content is. NOTE: This command is only available for `tsserver`. A plug mapping `(ale_documentation)` is defined for this command. ALEFindReferences *ALEFindReferences* Find references in the codebase for the symbol under the cursor using the enabled LSP linters for the buffer. ALE will display a preview window containing the results if some references are found. The window can be navigated using the usual Vim navigation commands. The Enter key (``) can be used to jump to a referencing location, or the `t` key can be used to jump to the location in a new tab. You can jump back to the position you were at before going to a reference of something with jump motions like CTRL-O. See |jump-motions|. A plug mapping `(ale_find_references)` is defined for this command. ALEFix *ALEFix* Fix problems with the current buffer. See |ale-fix| for more information. A plug mapping `(ale_fix)` is defined for this command. ALEFixSuggest *ALEFixSuggest* Suggest tools that can be used to fix problems in the current buffer. See |ale-fix| for more information. ALEGoToDefinition *ALEGoToDefinition* Jump to the definition of a symbol under the cursor using the enabled LSP linters for the buffer. ALE will jump to a definition if an LSP server provides a location to jump to. Otherwise, ALE will do nothing. You can jump back to the position you were at before going to the definition of something with jump motions like CTRL-O. See |jump-motions|. A plug mapping `(ale_go_to_definition)` is defined for this command. ALEGoToDefinitionInTab *ALEGoToDefinitionInTab* The same as |ALEGoToDefinition|, but opens results in a new tab. A plug mapping `(ale_go_to_definition_in_tab)` is defined for this command. ALEGoToDefinitionInSplit *ALEGoToDefinitionInSplit* The same as |ALEGoToDefinition|, but opens results in a new split. A plug mapping `(ale_go_to_definition_in_split)` is defined for this command. ALEGoToDefinitionInVSplit *ALEGoToDefinitionInVSplit* The same as |ALEGoToDefinition|, but opens results in a new vertical split. A plug mapping `(ale_go_to_definition_in_vsplit)` is defined for this command. ALEGoToTypeDefinition *ALEGoToTypeDefinition* This works similar to |ALEGoToDefinition| but instead jumps to the definition of a type of a symbol under the cursor. ALE will jump to a definition if an LSP server provides a location to jump to. Otherwise, ALE will do nothing. You can jump back to the position you were at before going to the definition of something with jump motions like CTRL-O. See |jump-motions|. A plug mapping `(ale_go_to_type_definition)` is defined for this command. ALEGoToTypeDefinitionInTab *ALEGoToTypeDefinitionInTab* The same as |ALEGoToTypeDefinition|, but opens results in a new tab. A plug mapping `(ale_go_to_type_definition_in_tab)` is defined for this command. ALEGoToTypeDefinitionInSplit *ALEGoToTypeDefinitionInSplit* The same as |ALEGoToTypeDefinition|, but opens results in a new split. A plug mapping `(ale_go_to_type_definition_in_split)` is defined for this command. ALEGoToTypeDefinitionInVSplit *ALEGoToTypeDefinitionInVSplit* The same as |ALEGoToTypeDefinition|, but opens results in a new vertical split. A plug mapping `(ale_go_to_type_definition_in_vsplit)` is defined for this command. ALEHover *ALEHover* Print brief information about the symbol under the cursor, taken from any available LSP linters. There may be a small non-blocking delay before information is printed. NOTE: In Vim 8, long messages will be shown in a preview window, as Vim 8 does not support showing a prompt to press enter to continue for long messages from asynchronous callbacks. A plug mapping `(ale_hover)` is defined for this command. ALESymbolSearch `` *ALESymbolSearch* Search for symbols in the workspace, taken from any available LSP linters. The arguments provided to this command will be used as a search query for finding symbols in the workspace, such as functions, types, etc. *:ALELint* ALELint *ALELint* Run ALE once for the current buffer. This command can be used to run ALE manually, instead of automatically, if desired. This command will also run linters where `lint_file` is set to `1`, or in other words linters which check the file instead of the Vim buffer. A plug mapping `(ale_lint)` is defined for this command. ALEPrevious *ALEPrevious* ALEPreviousWrap *ALEPreviousWrap* ALENext *ALENext* ALENextWrap *ALENextWrap* ALEFirst *ALEFirst* ALELast *ALELast* *ale-navigation-commands* Move between warnings or errors in a buffer. ALE will only navigate between the errors or warnings it generated, even if both |g:ale_set_quickfix| and |g:ale_set_loclist| are set to `0`. `ALEPrevious` and `ALENext` will stop at the top and bottom of a file, while `ALEPreviousWrap` and `ALENextWrap` will wrap around the file to find the last or first warning or error in the file, respectively. `ALEPrevious` and `ALENext` take optional flags arguments to custom their behaviour : `-wrap` enable wrapping around the file `-error`, `-warning` and `-info` enable jumping to errors, warnings or infos respectively, ignoring anything else. They are mutually exclusive and if several are provided the priority is the following: error > warning > info. `-style` and `-nostyle` allow you to jump respectively to style error or warning and to not style error or warning. They also are mutually exclusive and nostyle has priority over style. Flags can be combined to create create custom jumping. Thus you can use ":ALENext -wrap -error -nosyle" to jump to the next error which is not a style error while going back to the begining of the file if needed. `ALEFirst` goes to the first error or warning in the buffer, while `ALELast` goes to the last one. The following || mappings are defined for the commands: > (ale_previous) - ALEPrevious (ale_previous_wrap) - ALEPreviousWrap (ale_previous_error) - ALEPrevious -error (ale_previous_wrap_error) - ALEPrevious -wrap -error (ale_previous_warning) - ALEPrevious -warning (ale_previous_wrap_warning) - ALEPrevious -wrap -warning (ale_next) - ALENext (ale_next_wrap) - ALENextWrap (ale_next_error) - ALENext -error (ale_next_wrap_error) - ALENext -wrap -error (ale_next_warning) - ALENext -warning (ale_next_wrap_warning) - ALENext -wrap -warning (ale_first) - ALEFirst (ale_last) - ALELast < For example, these commands could be bound to the keys Ctrl + j and Ctrl + k: > " Map movement through errors without wrapping. nmap (ale_previous) nmap (ale_next) " OR map keys to use wrapping. nmap (ale_previous_wrap) nmap (ale_next_wrap) < ALEToggle *ALEToggle* ALEEnable *ALEEnable* ALEDisable *ALEDisable* ALEToggleBuffer *ALEToggleBuffer* ALEEnableBuffer *ALEEnableBuffer* ALEDisableBuffer *ALEDisableBuffer* `ALEToggle`, `ALEEnable`, and `ALEDisable` enable or disable ALE linting, including all of its autocmd events, loclist items, quickfix items, signs, current jobs, etc., globally. Executing any of these commands will change the |g:ale_enabled| variable. ALE can be disabled or enabled for only a single buffer with `ALEToggleBuffer`, `ALEEnableBuffer`, and `ALEDisableBuffer`. Disabling ALE for a buffer will not remove autocmd events, but will prevent ALE from checking for problems and reporting problems for whatever buffer the `ALEDisableBuffer` or `ALEToggleBuffer` command is executed from. These commands can be used for temporarily disabling ALE for a buffer. These commands will modify the |b:ale_enabled| variable. ALE linting cannot be enabled for a single buffer when it is disabled globally, as disabling ALE globally removes the autocmd events needed to perform linting with. The following plug mappings are defined, for conveniently defining keybinds: |ALEToggle| - `(ale_toggle)` |ALEEnable| - `(ale_enable)` |ALEDisable| - `(ale_disable)` |ALEToggleBuffer| - `(ale_toggle_buffer)` |ALEEnableBuffer| - `(ale_enable_buffer)` |ALEDisableBuffer| - `(ale_disable_buffer)` For removing problems reported by ALE, but leaving ALE enabled, see |ALEReset| and |ALEResetBuffer|. *:ALEDetail* ALEDetail *ALEDetail* Show the full linter message for the problem nearest to the cursor on the given line in the preview window. The preview window can be easily closed with the `q` key. If there is no message to show, the window will not be opened. If a loclist item has a `detail` key set, the message for that key will be preferred over `text`. See |ale-loclist-format|. A plug mapping `(ale_detail)` is defined for this command. *:ALEInfo* ALEInfo *ALEInfo* ALEInfoToClipboard *ALEInfoToClipboard* Print runtime information about ALE, including the values of global and buffer-local settings for ALE, the linters that are enabled, the commands that have been run, and the output of commands. ALE will log the commands that are run by default. If you wish to disable this, set |g:ale_history_enabled| to `0`. Because it could be expensive, ALE does not remember the output of recent commands by default. Set |g:ale_history_log_output| to `1` to enable logging of output for commands. ALE will only log the output captured for parsing problems, etc. The command `:ALEInfoToClipboard` can be used to output ALEInfo directly to your clipboard. This might not work on every machine. `:ALEInfoToFile` will write the ALE runtime information to a given filename. The filename works just like |:w|. ALEReset *ALEReset* ALEResetBuffer *ALEResetBuffer* `ALEReset` will remove all problems reported by ALE for all buffers. `ALEResetBuffer` will remove all problems reported for a single buffer. Either command will leave ALE linting enabled, so ALE will report problems when linting is performed again. See |ale-lint| for more information. The following plug mappings are defined, for conveniently defining keybinds: |ALEReset| - `(ale_reset)` |ALEResetBuffer| - `(ale_reset_buffer)` ALE can be disabled globally or for a buffer with |ALEDisable| or |ALEDisableBuffer|. ALEStopAllLSPs *ALEStopAllLSPs* `ALEStopAllLSPs` will close and stop all channels and jobs for all LSP-like clients, including tsserver, remove all of the data stored for them, and delete all of the problems found for them, updating every linted buffer. This command can be used when LSP clients mess up and need to be restarted. =============================================================================== 9. API *ale-api* ALE offers a number of functions for running linters or fixers, or defining them. The following functions are part of the publicly documented part of that API, and should be expected to continue to work. ale#Env(variable_name, value) *ale#Env()* Given a variable name and a string value, produce a string for including in a command for setting environment variables. This function can be used for building a command like so. > :echo string(ale#Env('VAR', 'some value') . 'command') 'VAR=''some value'' command' # On Linux or Mac OSX 'set VAR="some value" && command' # On Windows ale#Pad(string) *ale#Pad()* Given a string or any |empty()| value, return either the string prefixed with a single space, or an empty string. This function can be used to build parts of a command from variables. ale#Queue(delay, [linting_flag, buffer_number]) *ale#Queue()* Run linters for the current buffer, based on the filetype of the buffer, with a given `delay`. A `delay` of `0` will run the linters immediately. The linters will always be run in the background. Calling this function again from the same buffer An optional `linting_flag` argument can be given. If `linting_flag` is `'lint_file'`, then linters where the `lint_file` option is set to `1` will be run. Linters with `lint_file` set to `1` are not run by default. An optional `buffer_number` argument can be given for specifying the buffer to check. The active buffer (`bufnr('')`) will be checked by default. *ale-cool-down* If an exception is thrown when queuing/running ALE linters, ALE will enter a cool down period where it will stop checking anything for a short period of time. This is to prevent ALE from seriously annoying users if a linter is broken, or when developing ALE itself. ale#command#CreateDirectory(buffer) *ale#command#CreateDirectory()* Create a new temporary directory with a unique name, and manage that directory with |ale#command#ManageDirectory()|, so it will be removed as soon as possible. It is advised to only call this function from a callback function for returning a linter command to run. ale#command#CreateFile(buffer) *ale#command#CreateFile()* Create a new temporary file with a unique name, and manage that file with |ale#command#ManageFile()|, so it will be removed as soon as possible. It is advised to only call this function from a callback function for returning a linter command to run. ale#command#Run(buffer, command, callback, [options]) *ale#command#Run()* Start running a job in the background, and pass the results to the given callback later. This function can be used for computing the results of ALE linter or fixer functions asynchronously with jobs. `buffer` must match the buffer being linted or fixed, `command` must be a |String| for a shell command to execute, `callback` must be defined as a |Funcref| to call later with the results, and an optional |Dictionary| of `options` can be provided. The `callback` will receive the arguments `(buffer, output, metadata)`, where the `buffer` will match the buffer given to the function, the `output` will be a `List` of lines of output from the job that was run, and the `metadata` will be a |Dictionary| with additional information about the job that was run, including: `exit_code` - A |Number| with the exit code for the program that was run. The result of this function is either a special |Dictionary| ALE will use for waiting for the command to finish, or `0` if the job is not started. The The return value of the `callback` will be used as the eventual result for whatever value is being given to ALE. For example: > function! s:GetCommand(buffer, output, meta) abort " Do something with a:output here, from the foo command. " This is used as the command to run for linting. return 'final command' endfunction " ... 'command': {b -> ale#command#Run(b, 'foo', function('s:GetCommand'))} < The result of a callback can also be the result of another call to this function, so that several commands can be arbitrarily chained together. For example: > function! s:GetAnotherCommand(buffer, output, meta) abort " We can finally return this command. return 'last command' endfunction function! s:GetCommand(buffer, output, meta) abort " We can return another deferred result. return ale#command#Run( \ a:buffer, \ 'second command', \ function('s:GetAnotherCommand') \) endfunction " ... 'command': {b -> ale#command#Run(b, 'foo', function('s:GetCommand'))} < The following `options` can be provided. `output_stream` - Either `'stdout'`, `'stderr'`, `'both'`, or `'none`' for selecting which output streams to read lines from. The default is `'stdout'` `executable` - An executable for formatting into `%e` in the command. If this option is not provided, formatting commands with `%e` will not work. `read_buffer` - If set to `1`, the buffer will be piped into the command. The default is `0`. `input` - When creating temporary files with `%t` or piping text into a command `input` can be set to a |List| of text to use instead of the buffer's text. ale#command#EscapeCommandPart(command_part) *ale#command#EscapeCommandPart()* Given a |String|, return a |String| with all `%` characters replaced with `%%` instead. This function can be used to escape strings which are dynamically generated for commands before handing them over to ALE, so that ALE doesn't treat any strings with `%` formatting sequences specially. ale#command#ManageDirectory(buffer, directory) *ale#command#ManageDirectory()* Like |ale#command#ManageFile()|, but directories and all of their contents will be deleted, akin to `rm -rf directory`, which could lead to loss of data if mistakes are made. This command will also delete any temporary filenames given to it. It is advised to use |ale#command#ManageFile()| instead for deleting single files. ale#command#ManageFile(buffer, filename) *ale#command#ManageFile()* Given a buffer number for a buffer currently running some linting or fixing tasks and a filename, register a filename with ALE for automatic deletion after linting or fixing is complete, or when Vim exits. If Vim exits suddenly, ALE will try its best to remove temporary files, but ALE cannot guarantee with absolute certainty that the files will be removed. It is advised to create temporary files in the operating system's managed temporary file directory, such as with |tempname()|. Directory names should not be given to this function. ALE will only delete files and symlinks given to this function. This is to prevent entire directories from being accidentally deleted, say in cases of writing `dir . '/' . filename` where `filename` is actually `''`, etc. ALE instead manages directories separately with the |ale#command#ManageDirectory| function. ale#engine#GetLoclist(buffer) *ale#engine#GetLoclist()* Given a buffer number, this function will return the list of problems reported by ALE for a given buffer in the format accepted by |setqflist()|. A reference to the buffer's list of problems will be returned. The list must be copied before applying |map()| or |filter()|. ale#engine#IsCheckingBuffer(buffer) *ale#engine#IsCheckingBuffer()* Given a buffer number, returns `1` when ALE is busy checking that buffer. This function can be used for status lines, tab names, etc. ale#fix#registry#Add(name, func, filetypes, desc, [aliases]) *ale#fix#registry#Add()* Given a |String| `name` for a name to add to the registry, a |String| `func` for a function name, a |List| `filetypes` for a list of filetypes to set for suggestions, and a |String| `desc` for a short description of the fixer, register a fixer in the registry. The `name` can then be used for |g:ale_fixers| in place of the function name, and suggested for fixing files. An optional |List| of |String|s for aliases can be passed as the `aliases` argument. These aliases can also be used for looking up a fixer function. ALE will search for fixers in the registry first by `name`, then by their `aliases`. ale#linter#Define(filetype, linter) *ale#linter#Define()* Given a |String| for a filetype and a |Dictionary| Describing a linter configuration, add a linter for the given filetype. The dictionaries each offer the following options: `name` The name of the linter. These names will be used by |g:ale_linters| option for enabling/disabling particular linters. This argument is required. `callback` A |String| or |Funcref| for a callback function accepting two arguments (buffer, lines), for a buffer number the output is for, and the lines of output from a linter. This callback function should return a |List| of |Dictionary| objects in the format accepted by |setqflist()|. The |List| will be sorted by line and then column order so it can be searched with a binary search by in future before being passed on to the |loclist|, etc. This argument is required, unless the linter is an LSP linter. In which case, this argument must not be defined, as LSP linters handle diagnostics automatically. See |ale-lsp-linters|. If the function named does not exist, including if the function is later deleted, ALE will behave as if the callback returned an empty list. The keys for each item in the List will be handled in the following manner: *ale-loclist-format* `text` - This error message is required. `detail` - An optional, more descriptive message. This message can be displayed with the |ALEDetail| command instead of the message for `text`, if set. `lnum` - The line number is required. Any strings will be automatically converted to numbers by using `str2nr()`. Line 0 will be moved to line 1, and lines beyond the end of the file will be moved to the end. `col` - The column number is optional and will default to `0`. Any strings will be automatically converted to number using `str2nr()`. `end_col` - An optional end column number. This key can be set to specify the column problems end on, for improved highlighting. `end_lnum` - An optional end line number. This key can set along with `end_col` for highlighting multi-line problems. `bufnr` - This key represents the buffer number the problems are for. This value will default to the buffer number being checked. The `filename` key can be set instead of this key, and then the eventual `bufnr` value in the final list will either represent the number for an open buffer or `-1` for a file not open in any buffer. `filename` - An optional filename for the file the problems are for. This should be an absolute path to a file. Problems for files which have not yet been opened will be set in those files after they are opened and have been checked at least once. Temporary files in directories used for Vim temporary files with `tempname()` will be assumed to be the buffer being checked, unless the `bufnr` key is also set with a valid number for some other buffer. `vcol` - Defaults to `0`. If set to `1`, ALE will convert virtual column positions for `col` and `end_col` to byte column positions. If the buffer is changed in-between checking it and displaying the results, the calculated byte column positions will probably be wrong. `type` - Defaults to `'E'`. `nr` - Defaults to `-1`. Numeric error code. If `nr` is not `-1`, `code` likely should contain the string representation of the same value. `code` - No default; may be unset. Human-readable |String| error code. `executable` A |String| naming the executable itself which will be run, or a |Funcref| for a function to call for computing the executable, accepting a buffer number. The result can be computed with |ale#command#Run()|. This value will be used to check if the program requested is installed or not. If an `executable` is not defined, the command will be run without checking if a program is executable first. Defining an executable path is recommended to avoid starting too many processes. `command` A |String| for a command to run asynchronously, or a |Funcref| for a function to call for computing the command, accepting a buffer number. The result can be computed with |ale#command#Run()|. This command will be fed the lines from the buffer to check, and will produce the lines of output given to the `callback`. `output_stream` A |String| for the output stream the lines of output should be read from for the command which is run. The accepted values are `'stdout'`, `'stderr'`, and `'both'`. This argument defaults to `'stdout'`. This argument can be set for linter programs which output their errors and warnings to the stderr stream instead of stdout. The option `'both'` will read from both stder and stdout at the same time. `read_buffer` A |Number| (`0` or `1`) indicating whether a command should read the Vim buffer as input via stdin. This option is set to `1` by default, and can be disabled if a command manually reads from a temporary file instead, etc. *ale-lint-file* `lint_file` A |Number| (`0` or `1`) indicating whether a command should read the file instead of the Vim buffer. This option can be used for linters which must check the file on disk, and which cannot check a Vim buffer instead. Linters set with this option will not be run as a user types, per |g:ale_lint_on_text_changed|. Linters will instead be run only when events occur against the file on disk, including |g:ale_lint_on_enter| and |g:ale_lint_on_save|. Linters with this option set to `1` will also be run when linters are run manually, per |ALELintPost-autocmd|. When this option is set to `1`, `read_buffer` will be set automatically to `0`. The two options cannot be used together. *ale-lsp-linters* `lsp` A |String| for defining LSP (Language Server Protocol) linters. This argument may be omitted or `''` when a linter does not represent an LSP linter. When this argument is set to `'stdio'`, then the linter will be defined as an LSP linter which keeps a process for a language server running, and communicates with it directly via a |channel|. `executable` and `command` must be set. When this argument is set to `'socket'`, then the linter will be defined as an LSP linter via a TCP socket connection. `address` must be set. ALE will not start a server automatically. When this argument is not empty `project_root` must be defined. `language` can be defined to describe the language for a file. The filetype will be used as the language by default. LSP linters handle diagnostics automatically, so the `callback` argument must not be defined. An optional `completion_filter` callback may be defined for filtering completion results. `initialization_options` may be defined to pass initialization options to the LSP. `lsp_config` may be defined to pass configuration settings to the LSP. `address` A |String| representing an address to connect to, or a |Funcref| accepting a buffer number and returning the |String|. The result can be computed with |ale#command#Run()|. This argument must only be set if the `lsp` argument is set to `'socket'`. `project_root` A |String| representing a path to the project for the file being checked with the language server, or a |Funcref| accepting a buffer number and returning the |String|. If an empty string is returned, the file will not be checked at all. This argument must only be set if the `lsp` argument is also set to a non-empty string. `language` A |String| representing the name of the language being checked, or a |Funcref| accepting a buffer number and returning the |String|. This string will be sent to the LSP to tell it what type of language is being checked. If a language isn't provided, the language will default to the value of the filetype given to |ale#linter#Define|. `completion_filter` A |String| or |Funcref| for a callback function accepting a buffer number and a completion item. The completion item will be a |Dictionary| following the Language Server Protocol `CompletionItem` interface as described in the specification, available online here: https://microsoft.github.io/language-server-protocol `aliases` A |List| of aliases for the linter name. This argument can be set with alternative names for selecting the linter with |g:ale_linters|. This setting can make it easier to guess the linter name by offering a few alternatives. `initialization_options` A |Dictionary| of initialization options for LSPs, or a |Funcref| for a callback function accepting a buffer number and returning the |Dictionary|. This will be fed (as JSON) to the LSP in the initialize command. `lsp_config` A |Dictionary| for configuring a language server, or a |Funcref| for a callback function accepting a buffer number and returning the |Dictionary|. This will be fed (as JSON) to the LSP in the workspace/didChangeConfiguration command. If temporary files or directories are created for commands run with `command`, then these temporary files or directories can be managed by ALE, for automatic deletion. See |ale#command#ManageFile()| and |ale#command#ManageDirectory| for more information. *ale-command-format-strings* All command strings will be formatted for special character sequences. Any substring `%s` will be replaced with the full path to the current file being edited. This format option can be used to pass the exact filename being edited to a program. For example: > 'command': 'eslint -f unix --stdin --stdin-filename %s' < Any substring `%t` will be replaced with a path to a temporary file. Merely adding `%t` will cause ALE to create a temporary file containing the contents of the buffer being checked. All occurrences of `%t` in command strings will reference the one temporary file. The temporary file will be created inside a temporary directory, and the entire temporary directory will be automatically deleted, following the behaviour of |ale#command#ManageDirectory|. This option can be used for some linters which do not support reading from stdin. For example: > 'command': 'ghc -fno-code -v0 %t', < Any substring `%e` will be replaced with the escaped executable supplied with `executable`. This provides a convenient way to define a command string which needs to include a dynamic executable name, but which is otherwise static. For example: > 'command': '%e --some-argument', < The character sequence `%%` can be used to emit a literal `%` into a command, so literal character sequences `%s` and `%t` can be escaped by using `%%s` and `%%t` instead, etc. If a callback for a command generates part of a command string which might possibly contain `%%`, `%s`, `%t`, or `%e`, where the special formatting behavior is not desired, the |ale#command#EscapeCommandPart()| function can be used to replace those characters to avoid formatting issues. *ale-linter-loading-behavior* *ale-linter-loading-behaviour* Linters for ALE will be loaded by searching |runtimepath| in the following format: > ale_linters//.vim < Any linters which exist anywhere in |runtimepath| with that directory structure will be automatically loaded for the matching |filetype|. Filetypes containing `.` characters will be split into individual parts, and files will be loaded for each filetype between the `.` characters. Linters can be defined from vimrc and other files as long as this function is loaded first. For example, the following code will define a Hello World linter in vimrc in Vim 8: > " Plugins have to be loaded first. " If you are using a plugin manager, run that first. packloadall call ale#linter#Define('vim', { \ 'name': 'echo-test', \ 'executable': 'echo', \ 'command': 'echo hello world', \ 'callback': {buffer, lines -> map(lines, '{"text": v:val, "lnum": 1}')}, \}) < ale#linter#Get(filetype) *ale#linter#Get()* Return all of linters configured for a given filetype as a |List| of |Dictionary| values in the format specified by |ale#linter#Define()|. Filetypes may be dot-separated to invoke linters for multiple filetypes: for instance, the filetype `javascript.jsx` will return linters for both the `javascript` and `jsx` filetype. Aliases may be defined in as described in |g:ale_linter_aliases|. Aliases are applied after dot-separated filetypes are broken up into their components. ale#linter#PreventLoading(filetype) *ale#linter#PreventLoading()* Given a `filetype`, prevent any more linters from being loaded from |runtimepath| for that filetype. This function can be called from vimrc or similar to prevent ALE from loading linters. ale#other_source#ShowResults(buffer, linter_name, loclist) *ale#other_source#ShowResults()* Show results from another source of information. `buffer` must be a valid buffer number, and `linter_name` must be a unique name for identifying another source of information. The `loclist` given where the problems in a buffer are, and should be provided in the format ALE uses for regular linter results. See |ale-loclist-format|. ale#other_source#StartChecking(buffer, linter_name) *ale#other_source#StartChecking()* Tell ALE that another source of information has started checking a buffer. `buffer` must be a valid buffer number, and `linter_name` must be a unique name for identifying another source of information. ale#statusline#Count(buffer) *ale#statusline#Count()* Given the number of a buffer which may have problems, return a |Dictionary| containing information about the number of problems detected by ALE. The following keys are supported: `error` -> The number of problems with type `E` and `sub_type != 'style'` `warning` -> The number of problems with type `W` and `sub_type != 'style'` `info` -> The number of problems with type `I` `style_error` -> The number of problems with type `E` and `sub_type == 'style'` `style_warning` -> The number of problems with type `W` and `sub_type == 'style'` `total` -> The total number of problems. ale#statusline#FirstProblem(buffer, type) *ale#statusline#FirstProblem()* Returns a copy of the first entry in the `loclist` that matches the supplied buffer number and problem type. If there is no such enty, an empty dictionary is returned. Problem type should be one of the strings listed below: `error` -> Returns the first `loclist` item with type `E` and `sub_type != 'style'` `warning` -> First item with type `W` and `sub_type != 'style'` `info` -> First item with type `I` `style_error` -> First item with type `E` and `sub_type == 'style'` `style_warning` -> First item with type `W` and `sub_type == 'style'` b:ale_linted *b:ale_linted* `b:ale_linted` is set to the number of times a buffer has been checked by ALE after all linters for one lint cycle have finished checking a buffer. This variable may not be defined until ALE first checks a buffer, so it should be accessed with |get()| or |getbufvar()|. For example: > " Print a message indicating how many times ALE has checked this buffer. echo 'ALE has checked this buffer ' . get(b:, 'ale_linted') . ' time(s).' " Print 'checked' using getbufvar() if a buffer has been checked. echo getbufvar(bufnr(''), 'ale_linted', 0) > 0 ? 'checked' : 'not checked' < g:ale_want_results_buffer *g:ale_want_results_buffer* `g:ale_want_results_buffer` is set to the number of the buffer being checked when the |ALEWantResults| event is signaled. This variable should be read to figure out which buffer other sources should lint. ALELintPre *ALELintPre-autocmd* *ALELintPre* ALELintPost *ALELintPost-autocmd* *ALELintPost* ALEFixPre *ALEFixPre-autocmd* *ALEFixPre* ALEFixPost *ALEFixPost-autocmd* *ALEFixPost* These |User| autocommands are triggered before and after every lint or fix cycle. They can be used to update statuslines, send notifications, etc. The autocmd commands are run with |:silent|, so |:unsilent| is required for echoing messges. For example to change the color of the statusline while the linter is running: > augroup ALEProgress autocmd! autocmd User ALELintPre hi Statusline ctermfg=darkgrey autocmd User ALELintPost hi Statusline ctermfg=NONE augroup END < Or to display the progress in the statusline: > let s:ale_running = 0 let l:stl .= '%{s:ale_running ? "[linting]" : ""}' augroup ALEProgress autocmd! autocmd User ALELintPre let s:ale_running = 1 | redrawstatus autocmd User ALELintPost let s:ale_running = 0 | redrawstatus augroup END < ALEJobStarted *ALEJobStarted-autocmd* *ALEJobStarted* This |User| autocommand is triggered immediately after a job is successfully run. This provides better accuracy for checking linter status with |ale#engine#IsCheckingBuffer()| over |ALELintPre-autocmd|, which is actually triggered before any linters are executed. ALEWantResults *ALEWantResults-autocmd* *ALEWantResults* This |User| autocommand is triggered before ALE begins a lint cycle. Another source can respond by calling |ale#other_source#StartChecking()|, and |ALELintPre| will be signaled thereafter, to allow other plugins to know that another source is checking the buffer. |g:ale_want_results_buffer| will be set to the number for a buffer being checked when the event is signaled, and deleted after the event is done. This variable should be read to know which buffer to check. Other plugins can use this event to start checking buffers when ALE events for checking buffers are triggered. =============================================================================== 10. Special Thanks *ale-special-thanks* Special thanks to Mark Grealish (https://www.bhalash.com/) for providing ALE's snazzy looking ale glass logo. Cheers, Mark! =============================================================================== 11. Contact *ale-contact* If you like this plugin, and wish to get in touch, check out the GitHub page for issues and more at https://github.com/w0rp/ale If you wish to contact the author of this plugin directly, please feel free to send an email to devw0rp@gmail.com. Please drink responsibly, or not at all, which is ironically the preference of w0rp, who is teetotal. =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: