RepoMirrors/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale synced 2024-12-30 10:02:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
d476578a40
ale/doc/ale.txt

2746 lines
118 KiB
Plaintext
Raw Normal View History

Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
*ale.txt* For Vim version 8.0.
Update ale.txt
2016-11-02 06:19:24 +00:00
*ale*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Echo string format (#76) * Implement an option to configure the echoed message, #48 Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s' * Add new options for defining the string used for errors in echoed message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str` * Change text output of some linters Now that the echoed message can be customized, no need to add the type to the text variable. * Update README & documentation file * Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options) * Added echo warning str option to the doc
2016-10-10 11:53:54 +00:00
ALE - Asynchronous Lint Engine
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
CONTENTS *ale-contents*
Document the mypy options, and fix spacing issues, largely in the documentation
2017-01-15 13:20:23 +00:00
1. Introduction.........................|ale-introduction|
2. Supported Languages & Tools..........|ale-support|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
3. Linting..............................|ale-lint|
Document ALEFix
2017-05-20 18:01:12 +00:00
4. Fixing Problems......................|ale-fix|
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
5. Language Server Protocol Support.....|ale-lsp|
5.1 Completion........................|ale-completion|
5.2 Go To Definition..................|ale-go-to-definition|
Add support for finding references using LSP servers or tsserver
2018-04-22 18:49:24 +00:00
5.3 Find References...................|ale-find-references|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
6. Global Options.......................|ale-options|
6.1 Highlights........................|ale-highlights|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
6.2 Options for write-good Linter.....|ale-write-good-options|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
7. Integration Documentation............|ale-integrations|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
asciidoc..............................|ale-asciidoc-options|
write-good..........................|ale-asciidoc-write-good|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
asm...................................|ale-asm-options|
gcc.................................|ale-asm-gcc|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
awk...................................|ale-awk-options|
gawk................................|ale-awk-gawk|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
c.....................................|ale-c-options|
clang...............................|ale-c-clang|
Add Clangd language server support for C
2018-07-22 17:30:57 +00:00
clangd..............................|ale-c-clangd|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
clang-format........................|ale-c-clangformat|
Added clang-tidy for C, too. A limited number of clang-tidy checks can be used with C, too. I pretty much copied and refactored the C++ clang-tidy linter, and added some documentation about C-compatible checks.
2017-08-05 13:21:02 +00:00
clangtidy...........................|ale-c-clangtidy|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
cppcheck............................|ale-c-cppcheck|
Providing cquery support for C files
2018-07-25 04:23:13 +00:00
cquery..............................|ale-c-cquery|
New linter: Flawfinder (#1361) * Flawfinder support added for C and C++ A minor modification to gcc handler was made to support flawfinder's single-line output format that does not have a space following the colon denoting the warning level. gcc handler still passes its Vader tests after this modification. * Documentation fixes * Revert documentation regression * Added Flawfinder to table of contents * Removed trailing whitespace * Follow ALE conventions better Added additional documentation and Vader tests
2018-02-25 14:11:04 +00:00
flawfinder..........................|ale-c-flawfinder|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
gcc.................................|ale-c-gcc|
Adds options to foodcritic linter (#437) * Adds options to foodcritic linter Adds a way to pass command line options to the foodcritic command and documentation about it. * Creates a simple test for foodcritic command callback This test simply runs the GetCommand function for the foodcritic linter and feeds it with some test variables to assert the command line is being created/escaped correctly. * Makes foodcritic linter use a command callback Following review comments, changes the foodcritic linter to use a `GetCommand` callback for the `command_callback` linter option. Makes sure that `~` are escaped: flags on foodcritic command line are negated by adding a `~` in front of the specific cop name: ``` foodcritic -t ~FC011 ``` But the way the commands are executed cause foodcritic to fail (since tilde is recognized as home directory). * Fixes the doc to include new variables
2017-04-05 17:21:47 +00:00
chef..................................|ale-chef-options|
foodcritic..........................|ale-chef-foodcritic|
add joker handler for clojure Adds new linter for clojure using joker https://github.com/candid82/joker fixes #975 ref #544 #1040
2017-11-15 21:46:51 +00:00
clojure...............................|ale-clojure-options|
joker...............................|ale-clojure-joker|
Add linter for AWS CloudFormation template file
2018-06-04 16:23:25 +00:00
cloudformation........................|ale-cloudformation-options|
cfn-python-lint.....................|ale-cloudformation-cfn-python-lint|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
cmake.................................|ale-cmake-options|
cmakelint...........................|ale-cmake-cmakelint|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
cpp...................................|ale-cpp-options|
clang...............................|ale-cpp-clang|
Enabling clangd for cpp, objc and objcpp
2018-08-22 11:35:10 +00:00
clangd..............................|ale-cpp-clangd|
Add clangcheck Linter to cpp (#686) Add a clangcheck linter
2017-06-24 15:10:04 +00:00
clangcheck..........................|ale-cpp-clangcheck|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
clang-format........................|ale-cpp-clangformat|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
clangtidy...........................|ale-cpp-clangtidy|
Add clazy as cpp linter
2018-08-24 09:52:33 +00:00
clazy...............................|ale-cpp-clazy|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
cppcheck............................|ale-cpp-cppcheck|
Add cpplint linter
2017-05-10 17:41:58 +00:00
cpplint.............................|ale-cpp-cpplint|
Add the cquery LSP #1475 #1594
2018-06-06 16:03:15 +00:00
cquery..............................|ale-cpp-cquery|
New linter: Flawfinder (#1361) * Flawfinder support added for C and C++ A minor modification to gcc handler was made to support flawfinder's single-line output format that does not have a space following the colon denoting the warning level. gcc handler still passes its Vader tests after this modification. * Documentation fixes * Revert documentation regression * Added Flawfinder to table of contents * Removed trailing whitespace * Follow ALE conventions better Added additional documentation and Vader tests
2018-02-25 14:11:04 +00:00
flawfinder..........................|ale-cpp-flawfinder|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
gcc.................................|ale-cpp-gcc|
Implemented review recommendations Implements suggestions and recommendations suggested by the first review of the "Advance C# linter based on mcs -t:module (#952)" pull request. - Clarifies and simplifies description of linters and options - Added links to help file and marked the mcsc linter as to be run only when file in buffer is saved or loaded. - Added comments to the mcsc.vim file to clarify code - removed type checks considered not necessary be reviewer. - addresses findings by vader - removed call to getcwd and cd in vim script - handler expands file names relative to route of source tree into absolute pathes. Fixes errors not being marked when vim is started from subdirectory of source tree. - implements tests for mcs.vim and mcsc.vim linter
2017-09-26 07:19:53 +00:00
c#....................................|ale-cs-options|
mcs.................................|ale-cs-mcs|
mcsc................................|ale-cs-mcsc|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
css...................................|ale-css-options|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
prettier............................|ale-css-prettier|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
stylelint...........................|ale-css-stylelint|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
cuda..................................|ale-cuda-options|
nvcc................................|ale-cuda-nvcc|
Fix #308 - Check Dart files with dartanalyzer
2017-07-18 22:57:33 +00:00
dart..................................|ale-dart-options|
dartanalyzer........................|ale-dart-dartanalyzer|
Added dartfmt fixer (#1683) * Added dartfmt to Fixers * Added dartfmt specific documentation
2018-07-01 12:55:41 +00:00
dartfmt.............................|ale-dart-dartfmt|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
dockerfile............................|ale-dockerfile-options|
hadolint............................|ale-dockerfile-hadolint|
add basic documentation for elixir mix
2017-10-22 23:44:44 +00:00
elixir................................|ale-elixir-options|
mix.................................|ale-elixir-mix|
Allow passing options to mix_format
2018-03-08 14:37:56 +00:00
mix_format..........................|ale-elixir-mix-format|
Add Elixir linter for dialyxir (#1257) * Add Elixir linter for dialyxir * Update doc/ale.txt with dialyxir * Keep elixir tools alphabetically ordered in README * Add a missing entry for dialyxir to the main documentation file.
2018-01-22 12:21:07 +00:00
dialyxir............................|ale-elixir-dialyxir|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
elm...................................|ale-elm-options|
elm-format..........................|ale-elm-elm-format|
elm-make............................|ale-elm-elm-make|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
erlang................................|ale-erlang-options|
erlc................................|ale-erlang-erlc|
Add SyntaxErl linter These changes add [SyntaxErl][1] integration. SyntaxErl is a syntax checker tool for Erlang. [1]: https://github.com/ten0s/syntaxerl
2017-07-16 11:35:43 +00:00
syntaxerl...........................|ale-erlang-syntaxerl|
Add erubis linter This linter works largely the same as the existing `erubylint` linter, except it works with `erubis` instead of `erb` as the driving command.
2017-08-21 20:34:42 +00:00
eruby.................................|ale-eruby-options|
Edit README and help
2017-12-26 18:00:28 +00:00
fish..................................|ale-fish-options|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
fortran...............................|ale-fortran-options|
gcc.................................|ale-fortran-gcc|
Add documentation and testing for fortls
2018-07-19 21:27:47 +00:00
language_server.....................|ale-fortran-language-server|
Fix some bad indentation
2018-01-02 13:22:40 +00:00
fountain..............................|ale-fountain-options|
Fix FusionScript documentation text alignment
2017-06-14 08:37:24 +00:00
fusionscript..........................|ale-fuse-options|
fusion-lint.........................|ale-fuse-fusionlint|
Add support for linting git commit message files (#1233)
2017-12-20 10:10:07 +00:00
git commit............................|ale-gitcommit-options|
gitlint.............................|ale-gitcommit-gitlint|
Add GLSL linter using glslang (#914) * Add a glslang linter for GLSL
2017-09-08 10:06:47 +00:00
glsl..................................|ale-glsl-options|
glslang.............................|ale-glsl-glslang|
Add glslls (#1179) * Add glslls-based LSP linter * Make logfile configureable
2017-12-01 17:36:44 +00:00
glslls..............................|ale-glsl-glslls|
Use g:ale_linters for turning gometalinter on, and update documentation as appropriate
2017-04-15 20:04:43 +00:00
go....................................|ale-go-options|
#1206 Add support for setting options for gobuild, and escape paths better
2018-02-04 13:55:09 +00:00
gobuild.............................|ale-go-gobuild|
gofmt fixer for Go (#970) Add a gofmt fixer for golang.
2017-10-03 17:54:35 +00:00
gofmt...............................|ale-go-gofmt|
feat: add ale_go_govet_options variable
2018-08-16 02:02:51 +00:00
govet...............................|ale-go-govet|
Use g:ale_linters for turning gometalinter on, and update documentation as appropriate
2017-04-15 20:04:43 +00:00
gometalinter........................|ale-go-gometalinter|
This fixes issue #936 by linting the whole package
2018-02-15 11:23:36 +00:00
staticcheck.........................|ale-go-staticcheck|
Added new linter for GraphQL: gqlint (#863) * Added new linter for GraphQL: GQLint * added help-files
2017-08-20 12:36:46 +00:00
graphql...............................|ale-graphql-options|
Add support for linting GraphQL with ESLint
2017-11-27 14:22:05 +00:00
eslint..............................|ale-graphql-eslint|
Added new linter for GraphQL: gqlint (#863) * Added new linter for GraphQL: GQLint * added help-files
2017-08-20 12:36:46 +00:00
gqlint..............................|ale-graphql-gqlint|
add prettier support for graphql
2018-01-05 12:02:05 +00:00
prettier............................|ale-graphql-prettier|
Split Hack out from PHP, modernize fixes #1738 - Replace previous `hh_client` usage with LSP client - Add `HHAST` linter - Split Hack from PHP: Hack is increasingly diverging from PHP: - Hack tools do not understand PHP - Most PHP tools do not handle Hack code well (including vim's syntax highightling files) - http://github.com/hhvm/vim-hack now sets filetype to `hack`
2018-07-27 20:50:59 +00:00
hack..................................|ale-hack-options|
hack................................|ale-hack-hack|
hackfmt.............................|ale-hack-hackfmt|
hhast...............................|ale-hack-hhast|
Add support for linting Handlebars templates with ember-template-lint (#452) * Ember-template-lint Handlebars template linter: initial handler, test. * Handlebars support with ember-template-lint: basic documentation entries.
2017-04-07 14:38:50 +00:00
handlebars............................|ale-handlebars-options|
ember-template-lint.................|ale-handlebars-embertemplatelint|
Prefer --fast for stack-build (#754) * Vim scripts shouldn't have hyphens Especially not ones that will be autoloaded. You can't have a hyphen in a function name, so autoloading functions based on filename will fail. * Add g:haskell_stack_build_options, default: --fast If we're going to use the --fast option, we may as well go the whole 9 yards and let the user configure the 'stack build' flags. * Create documentation for stack-build options
2017-07-11 12:05:13 +00:00
haskell...............................|ale-haskell-options|
Add brittany for Haskell formatting `brittany` is one of the options for Haskell source formatting. This adds the necessary fixer files and documentation to support `brittany` in `ALE`.
2017-11-28 22:58:13 +00:00
brittany............................|ale-haskell-brittany|
add ghc entry to the ToC
2018-01-02 04:28:49 +00:00
ghc.................................|ale-haskell-ghc|
Add cabal-ghc linter cabal-ghc calls ghc via cabal exec and so ghc has access to packages in cabal sandboxes for example
2018-07-20 14:30:16 +00:00
cabal-ghc...........................|ale-haskell-cabal-ghc|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
hdevtools...........................|ale-haskell-hdevtools|
adds fixer support for hfmt (#1027) Add support for fixing Haskell with hfmt
2017-10-24 21:29:04 +00:00
hfmt................................|ale-haskell-hfmt|
Add hlint refactoring as a fixer (#1836)
2018-08-23 22:23:54 +00:00
hlint...............................|ale-haskell-hlint|
Prefer --fast for stack-build (#754) * Vim scripts shouldn't have hyphens Especially not ones that will be autoloaded. You can't have a hyphen in a function name, so autoloading functions based on filename will fail. * Add g:haskell_stack_build_options, default: --fast If we're going to use the --fast option, we may as well go the whole 9 yards and let the user configure the 'stack build' flags. * Create documentation for stack-build options
2017-07-11 12:05:13 +00:00
stack-build.........................|ale-haskell-stack-build|
Add stylish-haskell as a fixer (#1837) * Add stylish-haskell as a fixer `stylish-haskell` is a common formatting tool for the haskell toolchain. It is not as advanced as `brittany` or `hindent`, but it is commonly used for formatting of imports and data declarations. This adds it as a fixer in ALE.
2018-08-23 22:14:59 +00:00
stylish-haskell.....................|ale-haskell-stylish-haskell|
Add Haskell IDE Engine (hie) support (#1735) * Adding support for haskell-ide-engine * Work with the current directory if no stack.yaml file is found * Added Cabal file detection, updated documentation and added tests * Updated help
2018-08-02 19:24:58 +00:00
hie.................................|ale-haskell-hie|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
html..................................|ale-html-options|
htmlhint............................|ale-html-htmlhint|
tidy................................|ale-html-tidy|
:books: Add html stylelint to TOC
2018-08-23 20:23:04 +00:00
stylelint...........................|ale-html-stylelint|
Sort the HTML documentation sections
2018-08-24 12:24:42 +00:00
write-good..........................|ale-html-write-good|
Add linter for Idris (#838) * Add linter for Idris * Fix parsing warnings and column ranges in Idris linter * Make Idris linter configurable. Fix help tag.
2017-08-10 20:09:58 +00:00
idris.................................|ale-idris-options|
idris...............................|ale-idris-idris|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
java..................................|ale-java-options|
Add checkstyle linter
2017-05-12 13:42:32 +00:00
checkstyle..........................|ale-java-checkstyle|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
javac...............................|ale-java-javac|
add google-java-format fixer
2017-12-09 13:52:15 +00:00
google-java-format..................|ale-java-google-java-format|
Add support for the java PMD linter
2018-04-09 15:45:08 +00:00
pmd.................................|ale-java-pmd|
Add java lsp linter to documentation
2018-08-26 11:58:17 +00:00
javalsp.............................|ale-java-javalsp|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
javascript............................|ale-javascript-options|
eslint..............................|ale-javascript-eslint|
flow................................|ale-javascript-flow|
added importjs fixer - added tests for fixer functions - added docs
2017-12-04 15:29:44 +00:00
importjs............................|ale-javascript-importjs|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
jscs................................|ale-javascript-jscs|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
jshint..............................|ale-javascript-jshint|
Support both prettier and prettier-eslint
2017-05-27 17:31:52 +00:00
prettier............................|ale-javascript-prettier|
prettier-eslint.....................|ale-javascript-prettier-eslint|
Add prettier-standard support (#702) * Add prettier-standard support * Update ale-javascript.txt Remove a duplicated header line.
2017-06-28 15:35:19 +00:00
prettier-standard...................|ale-javascript-prettier-standard|
#326 Document existing StandardJS options
2017-03-28 22:48:55 +00:00
standard............................|ale-javascript-standard|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
xo..................................|ale-javascript-xo|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
json..................................|ale-json-options|
Support fixing JSON files with fixjson
2018-01-24 10:36:02 +00:00
fixjson.............................|ale-json-fixjson|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
jsonlint............................|ale-json-jsonlint|
Add jq as a JSON fixer
2018-01-24 10:12:29 +00:00
jq..................................|ale-json-jq|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
prettier............................|ale-json-prettier|
Add kotlinc checker for kotlin (#526) * Add kotlinc checker for kotlin
2017-05-02 17:27:04 +00:00
kotlin................................|ale-kotlin-options|
kotlinc.............................|ale-kotlin-kotlinc|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
ktlint..............................|ale-kotlin-ktlint|
Add kotlin language server support (#1725) * Add kotlin languageserver linter definition * Added kotlin languageserver references in docs, fix missing !! on other linters * Added Vader tests for root path detection in Kotlin Language Server
2018-07-15 17:54:18 +00:00
languageserver......................|ale-kotlin-languageserver|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
latex.................................|ale-latex-options|
write-good..........................|ale-latex-write-good|
add prettier fixer support for 'less' filetype
2017-10-21 01:29:57 +00:00
less..................................|ale-less-options|
Add tests for the command and executable callbacks, and make them use local node_modulse esxecutables like other linters
2017-11-12 11:25:24 +00:00
lessc...............................|ale-less-lessc|
add prettier fixer support for 'less' filetype
2017-10-21 01:29:57 +00:00
prettier............................|ale-less-prettier|
Fix #510 Support checking LESS files with stylelint
2017-11-12 12:09:19 +00:00
stylelint...........................|ale-less-stylelint|
Add llc integration for LLVM IR (#979) Check LLVM IR with llc
2017-10-10 09:13:09 +00:00
llvm..................................|ale-llvm-options|
llc.................................|ale-llvm-llc|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
lua...................................|ale-lua-options|
Add a luac linter for Lua
2018-01-08 15:19:17 +00:00
luac................................|ale-lua-luac|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
luacheck............................|ale-lua-luacheck|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
markdown..............................|ale-markdown-options|
Add options for markdown_mdl linter
2018-02-26 03:46:51 +00:00
mdl.................................|ale-markdown-mdl|
Enable prettier to format markdown files
2018-01-15 02:22:09 +00:00
prettier............................|ale-markdown-prettier|
Add a missing ToC entry for remark-lint
2018-07-16 12:34:30 +00:00
remark-lint.........................|ale-markdown-remark-lint|
Update document for textlint
2018-03-24 05:39:05 +00:00
textlint............................|ale-markdown-textlint|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
write-good..........................|ale-markdown-write-good|
add documentation on mmc linter
2018-03-25 17:43:51 +00:00
mercury...............................|ale-mercury-options|
mmc.................................|ale-mercury-mmc|
Added NASM linter Added NASM linter (for nasm filetype).
2018-05-04 19:44:32 +00:00
nasm..................................|ale-nasm-options|
nasm................................|ale-nasm-nasm|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
nroff.................................|ale-nroff-options|
write-good..........................|ale-nroff-write-good|
add clang for objc and objcpp
2017-05-19 16:41:57 +00:00
objc..................................|ale-objc-options|
clang...............................|ale-objc-clang|
Enabling clangd for cpp, objc and objcpp
2018-08-22 11:35:10 +00:00
clangd..............................|ale-objc-clangd|
add clang for objc and objcpp
2017-05-19 16:41:57 +00:00
objcpp................................|ale-objcpp-options|
clang...............................|ale-objcpp-clang|
Enabling clangd for cpp, objc and objcpp
2018-08-22 11:35:10 +00:00
clangd..............................|ale-objcpp-clangd|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
ocaml.................................|ale-ocaml-options|
merlin..............................|ale-ocaml-merlin|
Add ocaml-language-server for OCaml and ReasonML
2017-11-11 18:27:41 +00:00
ols.................................|ale-ocaml-ols|
add ocamlformat support
2018-08-26 11:47:56 +00:00
ocamlformat.........................|ale-ocaml-ocamlformat|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
perl..................................|ale-perl-options|
perl................................|ale-perl-perl|
Perlcritic column number and rule names (#640) * Add column number to perlcritic linting output This returns the column number of the perlcritic error so that ale can show the column in addition to the line where perlcritic found an error. * Add perlcritic configuration for rule names This adds a configuration setting so that the name of the perlcritic rule is shown [Rule::Name] after the error message. This is useful to lookup the rule failure. * Add a vader test for perlcritic#GetCommand
2017-06-11 20:13:47 +00:00
perlcritic..........................|ale-perl-perlcritic|
add perltidy fixer
2018-04-21 13:09:38 +00:00
perltidy............................|ale-perl-perltidy|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
php...................................|ale-php-options|
Document the PHP langserver integration
2017-08-07 12:08:51 +00:00
langserver..........................|ale-php-langserver|
Add phan as a linter for php files (#1026) Add phan for checking PHP code
2017-10-24 21:25:02 +00:00
phan................................|ale-php-phan|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
phpcbf..............................|ale-php-phpcbf|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
phpcs...............................|ale-php-phpcs|
phpmd...............................|ale-php-phpmd|
Added phpstan linter for php. (#772) * Added phpstan linter for php.
2017-07-16 14:04:25 +00:00
phpstan.............................|ale-php-phpstan|
add php-cs-fixer to list of fixers
2018-03-01 14:41:05 +00:00
php-cs-fixer........................|ale-php-php-cs-fixer|
add po support with proselint, writegood, msgfmt and alex
2018-01-27 11:40:40 +00:00
po....................................|ale-po-options|
write-good..........................|ale-po-write-good|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
pod...................................|ale-pod-options|
write-good..........................|ale-pod-write-good|
functional pony linter
2018-02-10 19:04:43 +00:00
pony..................................|ale-pony-options|
ponyc...............................|ale-pony-ponyc|
Added support for linting of proto files (#1098) * Added support for linting of proto files * Added function to get the proper protoc command
2017-11-10 09:37:23 +00:00
proto.................................|ale-proto-options|
protoc-gen-lint.....................|ale-proto-protoc-gen-lint|
Make pug-lint detect node_modules executables, and add options for pug-lint like the other linters
2017-06-29 10:40:03 +00:00
pug...................................|ale-pug-options|
puglint.............................|ale-pug-puglint|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
puppet................................|ale-puppet-options|
Update TOC for ale-puppet-puppet
2018-08-27 18:12:56 +00:00
puppet..............................|ale-puppet-puppet|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
puppetlint..........................|ale-puppet-puppetlint|
puppet: Add puppet-languageserver linter
2018-07-04 11:36:50 +00:00
puppet-languageserver...............|ale-puppet-languageserver|
Improve pyrex cython linter. Like many other linters, use variables for the executable and options used by the linter. By default, the linter now report every warnings as errors with `--warning-errors`. Also add include directory and set working directory to file directory.
2018-06-25 07:51:50 +00:00
pyrex (cython)........................|ale-pyrex-options|
cython..............................|ale-pyrex-cython|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
python................................|ale-python-options|
#659 - Add options for Python fixers, and cut down on duplicated documentation
2017-06-18 10:03:31 +00:00
autopep8............................|ale-python-autopep8|
Added support for Python black fixer (#1451)
2018-04-06 09:08:25 +00:00
black...............................|ale-python-black|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
flake8..............................|ale-python-flake8|
#659 - Add options for Python fixers, and cut down on duplicated documentation
2017-06-18 10:03:31 +00:00
isort...............................|ale-python-isort|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
mypy................................|ale-python-mypy|
Add prospector for checking Python code (#1183)
2017-12-01 17:04:30 +00:00
prospector..........................|ale-python-prospector|
Add pycodestyle Python linter support (#872) Add a pycodestyle linter
2017-08-25 11:46:56 +00:00
pycodestyle.........................|ale-python-pycodestyle|
Allow all Python linter executables to be set to `pipenv`. It appends ` run {linter_name}`, analogously to the Ruby linters when the executable is set to `bundle`
2018-06-05 02:43:02 +00:00
pyflakes............................|ale-python-pyflakes|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
pylint..............................|ale-python-pylint|
Add PyLS linter (#1097) * Support PyLS (python language server) * Replace pyls#GetProjectRoot and add more config types to ale#python#FindProjectRoot
2017-11-08 17:58:56 +00:00
pyls................................|ale-python-pyls|
add pyre lsp linter to python linters
2018-07-01 18:59:49 +00:00
pyre................................|ale-python-pyre|
Add support for 'vulture' for Python
2018-07-26 07:41:27 +00:00
vulture.............................|ale-python-vulture|
#659 - Add options for Python fixers, and cut down on duplicated documentation
2017-06-18 10:03:31 +00:00
yapf................................|ale-python-yapf|
Integration of qmlfmt linting tool (#1462) * Add first qmlfmt support * Add GetCommand() function - pass --error/-e option * Add handle unittest - fix pattern regex - store col as integer * Update docs * Add command callback unit test
2018-04-05 19:09:41 +00:00
qml...................................|ale-qml-options|
qmlfmt..............................|ale-qml-qmlfmt|
Document the new lintr option
2017-09-03 22:36:58 +00:00
r.....................................|ale-r-options|
lintr...............................|ale-r-lintr|
Fix numerous issues with integration documentation tags and the table of contents, and add a script to check for theses issues
2017-09-10 18:42:45 +00:00
reasonml..............................|ale-reasonml-options|
merlin..............................|ale-reasonml-merlin|
Add ocaml-language-server for OCaml and ReasonML
2017-11-11 18:27:41 +00:00
ols.................................|ale-reasonml-ols|
refmt fixer for ReasonML
2017-10-29 15:27:52 +00:00
refmt...............................|ale-reasonml-refmt|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
restructuredtext......................|ale-restructuredtext-options|
write-good..........................|ale-restructuredtext-write-good|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
ruby..................................|ale-ruby-options|
Add rails_best_practices handler (resolves #655) (#751) * Move FindRailsRoot() to more general location * Add rails_best_practices handler (resolves #655) * Update documentation for rails_best_practices Also add brakeman to *ale* documentation. * rails_best_practices: allow overriding the executable * rails_best_practices: format help correctly * rails_best_practices: capture tool output on Windows
2017-07-12 09:43:47 +00:00
brakeman............................|ale-ruby-brakeman|
rails_best_practices................|ale-ruby-rails_best_practices|
Add the Reek checker for Ruby. (#490) Add the Reek checker for Ruby.
2017-04-20 06:37:08 +00:00
reek................................|ale-ruby-reek|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
rubocop.............................|ale-ruby-rubocop|
Fix #1168 - Make the ruby linter executable configurable
2017-11-28 09:47:04 +00:00
ruby................................|ale-ruby-ruby|
Add rufo fixer for ruby files
2018-03-11 04:33:57 +00:00
rufo................................|ale-ruby-rufo|
Add solargraph LSP linter.
2018-08-24 04:02:51 +00:00
solargraph..........................|ale-ruby-solargraph|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
rust..................................|ale-rust-options|
cargo...............................|ale-rust-cargo|
Document the rls linter
2017-08-07 12:00:17 +00:00
rls.................................|ale-rust-rls|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
rustc...............................|ale-rust-rustc|
add rustfmt fixer
2017-10-21 17:31:49 +00:00
rustfmt.............................|ale-rust-rustfmt|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
sass..................................|ale-sass-options|
stylelint...........................|ale-sass-stylelint|
Add scalastyle linter (#766) * Add support for scalastyle * Add scalastyle docs * scalastyle support for column numbers * off by one column * Add tests for scalastyle command and handler * update readme for scalastyle * allow full scalastyle options instead of just config file * fix indentation * allow scalastyle config file in parent directories by a couple names. * check for missing match args with empty * remove echo * use a for loop
2017-07-13 22:41:01 +00:00
scala.................................|ale-scala-options|
added sbtserver linter
2018-08-27 05:12:56 +00:00
sbtserver...........................|ale-scala-sbtserver|
Add 'scalafmt' fixer for Scala files closes https://github.com/w0rp/ale/issues/1299
2018-06-02 18:59:53 +00:00
scalafmt............................|ale-scala-scalafmt|
Add scalastyle linter (#766) * Add support for scalastyle * Add scalastyle docs * scalastyle support for column numbers * off by one column * Add tests for scalastyle command and handler * update readme for scalastyle * allow full scalastyle options instead of just config file * fix indentation * allow scalastyle config file in parent directories by a couple names. * check for missing match args with empty * remove echo * use a for loop
2017-07-13 22:41:01 +00:00
scalastyle..........................|ale-scala-scalastyle|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
scss..................................|ale-scss-options|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
prettier............................|ale-scss-prettier|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
stylelint...........................|ale-scss-stylelint|
sh....................................|ale-sh-options|
sh: add bash-language-server linter
2018-06-07 17:55:43 +00:00
sh-language-server..................|ale-sh-language-server|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
shell...............................|ale-sh-shell|
shellcheck..........................|ale-sh-shellcheck|
Add shfmt fixer for sh files (#1083) * Add shfmt fixer for sh files * Add tests for shfmt fixer
2017-11-05 21:24:41 +00:00
shfmt...............................|ale-sh-shfmt|
Detect and use CM files for smlnj (#884) * Detect and use CM files for smlnj * Split into two checkers - one for CM projects - one for single SML files * Fix some typos * Fix error caught by writing tests We want to actually use `glob` to search in paths upwards from us. (Previously we were just searching in the current directory every time!) * Fix errors from former test run * Write tests for GetCmFile and GetExecutableSmlnj * Typo in 'smlnj/' fixture filenames
2017-09-03 18:56:14 +00:00
sml...................................|ale-sml-options|
smlnj...............................|ale-sml-smlnj|
Add solidity linter: solium
2017-09-13 17:45:18 +00:00
solidity..............................|ale-solidity-options|
Update documentation
2017-12-04 17:23:34 +00:00
solhint.............................|ale-solidity-solhint|
Add solidity linter: solium
2017-09-13 17:45:18 +00:00
solium..............................|ale-solidity-solium|
Add rpm spec file linter (rpmlint) (#486) * Initial attempt at an rpmlint linter. * Add some basic documentation. * Play with indentation in the test file. * Another attempt to fix the rpmlint test. * Hopefully this does it.
2017-04-19 22:40:58 +00:00
spec..................................|ale-spec-options|
rpmlint.............................|ale-spec-rpmlint|
Fix #178 - Check Stylus files with stylelint
2017-07-03 15:57:39 +00:00
stylus................................|ale-stylus-options|
stylelint...........................|ale-stylus-stylelint|
Add Tcl nagelfar linter
2017-08-02 22:05:19 +00:00
tcl...................................|ale-tcl-options|
nagelfar............................|ale-tcl-nagelfar|
Add tflint fot Terraform
2017-10-26 18:32:33 +00:00
terraform.............................|ale-terraform-options|
tflint..............................|ale-terraform-tflint|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
tex...................................|ale-tex-options|
chktex..............................|ale-tex-chktex|
lacheck.............................|ale-tex-lacheck|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
texinfo...............................|ale-texinfo-options|
write-good..........................|ale-texinfo-write-good|
text..................................|ale-text-options|
Update document for textlint
2018-03-24 05:39:05 +00:00
textlint............................|ale-text-textlint|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
write-good..........................|ale-text-write-good|
Add a linter for Apache Thrift IDL files This linter works by invoking the `thrift` compiler with the buffer contents and reporting any parser and code generation issues. The handler rolls its own output-matching loop because we have the (unfortunate) requirement of handling error output that spans multiple lines. Unit tests cover both the command callback and handler, and there is initial documentation for all of the option variables.
2017-08-30 17:59:40 +00:00
thrift................................|ale-thrift-options|
thrift..............................|ale-thrift-thrift|
Add missing "use global" var for tslint (#484) * Add missing "use global" var for tslint * Add typescript tslint documentation
2017-04-18 08:28:54 +00:00
typescript............................|ale-typescript-options|
Fix #668 - Support eslint for TypeScript
2017-06-20 09:50:38 +00:00
eslint..............................|ale-typescript-eslint|
Add 'prettier' fixer support to TypeScript, CSS, SCSS and JSON (#910) * Add prettier fixer support for typescript * Add prettier fixer support for css and scss * Add prettier fixer support for json * Use getbufvar() to get &filetype
2017-09-06 14:21:26 +00:00
prettier............................|ale-typescript-prettier|
Add missing "use global" var for tslint (#484) * Add missing "use global" var for tslint * Add typescript tslint documentation
2017-04-18 08:28:54 +00:00
tslint..............................|ale-typescript-tslint|
Document the tsserver linter
2017-06-13 16:59:09 +00:00
tsserver............................|ale-typescript-tsserver|
Adds an option to pass additional arguments to the verilog/verilator … (#698) * Adds an option to pass additional arguments to the verilog/verilator linter The new otion is g:ale_verilog_verilator_options + doc * Spell check verilog linter doc file * Add entries to the verilog linters in the doc table of content * Vader test for verilog/verilator linter args option verilog_verilator_options
2017-06-29 08:15:52 +00:00
verilog/systemverilog.................|ale-verilog-options|
iverilog............................|ale-verilog-iverilog|
verilator...........................|ale-verilog-verilator|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
vim...................................|ale-vim-options|
vint................................|ale-vim-vint|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
vim help..............................|ale-vim-help-options|
write-good..........................|ale-vim-help-write-good|
Add prettier fixer support to vue
2018-01-31 16:29:01 +00:00
vue...................................|ale-vue-options|
prettier............................|ale-vue-prettier|
vue: Add the vls language server linter
2018-07-05 12:04:20 +00:00
vls.................................|ale-vue-vls|
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
xhtml.................................|ale-xhtml-options|
write-good..........................|ale-xhtml-write-good|
Add xmllint linter (#559) * Add xmllint linter for xml
2017-05-18 08:31:12 +00:00
xml...................................|ale-xml-options|
xmllint.............................|ale-xml-xmllint|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
yaml..................................|ale-yaml-options|
Add prettier as a YAML option (#1789) * Add prettier as a yaml fixer * Sort yaml fixers alphabetically * Add prettier to doc/ale.txt * Add ale-yaml-prettier * Add ale-yaml-prettier to the TOC
2018-08-08 17:48:28 +00:00
prettier............................|ale-yaml-prettier|
Add yaml swaglint linter (#771) * Add yaml swaglint linter
2017-07-17 19:28:21 +00:00
swaglint............................|ale-yaml-swaglint|
Move linter documentation into separate files
2017-03-28 22:25:44 +00:00
yamllint............................|ale-yaml-yamllint|
Add support for yang-lsp
2018-08-03 19:59:32 +00:00
yang..................................|ale-yang-options|
yang-lsp............................|ale-yang-lsp|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
8. Commands/Keybinds....................|ale-commands|
9. API..................................|ale-api|
10. Special Thanks......................|ale-special-thanks|
11. Contact.............................|ale-contact|
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
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,
doc: fix misspelled feature name
2018-03-21 16:02:43 +00:00
Vim must be compiled with the |job| and |channel| and |timers| features
Add a help file for the project.
2016-10-05 23:22:32 +00:00
as a minimum.
Document ALEFix
2017-05-20 18:01:12 +00:00
ALE supports the following key features for linting:
Add a help file for the project.
2016-10-05 23:22:32 +00:00
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.
Document ALEFix
2017-05-20 18:01:12 +00:00
7. Setting syntax highlights for errors.
ALE can fix problems with files with the |ALEFix| command, using the same job
Use a new window for the ALEFixSuggest command, and document it better
2017-06-28 15:20:01 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Move design goals to online documentation
2018-06-28 15:20:30 +00:00
If you are interested in contributing to the development of ALE, read the
developer documentation. See |ale-development|
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
2. Supported Languages & Tools *ale-support*
The following languages and tools are supported.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Notes:
`^` No linters for text or Vim help filetypes are enabled by default.
Use two exclamation marks for marking lint file linters, which are easier to see and click
2017-08-28 21:08:55 +00:00
`!!` These linters check only files on disk. See |ale-lint-file-linters|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* ASM: `gcc`
* Ansible: `ansible-lint`
Add `drafter` for checking API Blueprint files (#1152)
2017-11-20 10:57:13 +00:00
* API Blueprint: `drafter`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* AsciiDoc: `alex`!!, `proselint`, `redpen`, `write-good`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Awk: `gawk`
sh: add bash-language-server linter
2018-06-07 17:55:43 +00:00
* Bash: `language-server`, `shell` (-n flag), `shellcheck`, `shfmt`
Add shfmt fixer for sh files (#1083) * Add shfmt fixer for sh files * Add tests for shfmt fixer
2017-11-05 21:24:41 +00:00
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
Providing cquery support for C files
2018-07-25 04:23:13 +00:00
* C: `cppcheck`, `cpplint`!!, `clang`, `clangd`, `clangtidy`!!, `clang-format`, `cquery`, `flawfinder`, `gcc`
Add clazy as cpp linter
2018-08-24 09:52:33 +00:00
* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `clazy`!!, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
Add cuda nvcc linter (#874) * add cuda nvcc linter
2017-09-07 18:23:58 +00:00
* CUDA: `nvcc`!!
Implemented review recommendations Implements suggestions and recommendations suggested by the first review of the "Advance C# linter based on mcs -t:module (#952)" pull request. - Clarifies and simplifies description of linters and options - Added links to help file and marked the mcsc linter as to be run only when file in buffer is saved or loaded. - Added comments to the mcsc.vim file to clarify code - removed type checks considered not necessary be reviewer. - addresses findings by vader - removed call to getcwd and cd in vim script - handler expands file names relative to route of source tree into absolute pathes. Fixes errors not being marked when vim is started from subdirectory of source tree. - implements tests for mcs.vim and mcsc.vim linter
2017-09-26 07:19:53 +00:00
* C#: `mcs`, `mcsc`!!
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Chef: `foodcritic`
add joker handler for clojure Adds new linter for clojure using joker https://github.com/candid82/joker fixes #975 ref #544 #1040
2017-11-15 21:46:51 +00:00
* Clojure: `joker`
Add linter for AWS CloudFormation template file
2018-06-04 16:23:25 +00:00
* CloudFormation: `cfn-python-lint`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* CMake: `cmakelint`
* CoffeeScript: `coffee`, `coffeelint`
Use two exclamation marks for marking lint file linters, which are easier to see and click
2017-08-28 21:08:55 +00:00
* Crystal: `crystal`!!
Sort some linter entries alphabetically
2017-11-12 12:11:15 +00:00
* CSS: `csslint`, `prettier`, `stylelint`
Add cucumber checker for cucumber files For now, it only detects undefined steps. The nearest `features` dir above the buffer file is loaded, so step definitions should be found correctly. Tested only with Cucumber for Ruby, but it should work for any cucumber that follows a substantially similar directory structure.
2018-04-17 04:29:13 +00:00
* Cucumber: `cucumber`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Cython (pyrex filetype): `cython`
* D: `dmd`
ale_linters: add 'dafny' linter
2017-11-08 06:11:49 +00:00
* Dafny: `dafny`!!
Added dartfmt fixer (#1683) * Added dartfmt to Fixers * Added dartfmt specific documentation
2018-07-01 12:55:41 +00:00
* Dart: `dartanalyzer`!!, `language_server`, dartfmt!!
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Dockerfile: `hadolint`
Add mix linter for elixir
2017-08-23 07:03:13 +00:00
* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!
Elm local install support (#915) * Add Elm support for npm local installation
2017-09-10 11:58:42 +00:00
* Elm: `elm-format, elm-make`
[eruby] Add erubi linter Erubi is yet another parser for eRuby. This is the default parser in Rails as of version 5.1. It supports some additional syntax with similar behavior to Rails' extensions to the language, though incompatible. Rails currently still recommends their own syntax, so GetCommand still has to do the translation introduced in https://github.com/w0rp/ale/pull/1114 . Erubi does not supply an executable—It is intended to be invoked only from within a Ruby program. In this case, a one-liner on the command line.
2017-11-12 05:53:02 +00:00
* Erb: `erb`, `erubi`, `erubis`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Erlang: `erlc`, `SyntaxErl`
Edit README and help
2017-12-26 18:00:28 +00:00
* Fish: `fish` (-n flag)
Add support for Fortran language server by @hansec
2018-07-19 17:25:45 +00:00
* Fortran: `gcc`, `language_server`
Add Fountain with proselint info to ale.txt. Add Fountain online documentation.
2017-12-20 18:39:10 +00:00
* Fountain: `proselint`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* FusionScript: `fusion-lint`
Add support for linting git commit message files (#1233)
2017-12-20 10:10:07 +00:00
* Git Commit Messages: `gitlint`
Add glslls (#1179) * Add glslls-based LSP linter * Make logfile configureable
2017-12-01 17:36:44 +00:00
* GLSL: glslang, `glslls`
Fix #1392 - Only check files on disk for gotype
2018-03-18 17:16:13 +00:00
* Go: `gofmt`, `goimports`, `go vet`!!, `golint`, `gotype`!!, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!!
add prettier support for graphql
2018-01-05 12:02:05 +00:00
* GraphQL: `eslint`, `gqlint`, `prettier`
Split Hack out from PHP, modernize fixes #1738 - Replace previous `hh_client` usage with LSP client - Add `HHAST` linter - Split Hack from PHP: Hack is increasingly diverging from PHP: - Hack tools do not understand PHP - Most PHP tools do not handle Hack code well (including vim's syntax highightling files) - http://github.com/hhvm/vim-hack now sets filetype to `hack`
2018-07-27 20:50:59 +00:00
* Hack: `hack`, `hackfmt`, `hhast`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Haml: `haml-lint`
* Handlebars: `ember-template-lint`
Add stylish-haskell as a fixer (#1837) * Add stylish-haskell as a fixer `stylish-haskell` is a common formatting tool for the haskell toolchain. It is not as advanced as `brittany` or `hindent`, but it is commonly used for formatting of imports and data declarations. This adds it as a fixer in ALE.
2018-08-23 22:14:59 +00:00
* Haskell: `brittany`, `ghc`, `cabal-ghc`, `stylish-haskell`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt`, `hie`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Idris: `idris`
Add java lsp linter to documentation
2018-08-26 11:58:17 +00:00
* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp`
Indicate that 4.2.0 is no longer strictly required for prettier-eslint, and add links for prettier-eslint and prettier-standard
2017-12-18 10:37:21 +00:00
* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo`
Support fixing JSON files with fixjson
2018-01-24 10:36:02 +00:00
* JSON: `fixjson`, `jsonlint`, `jq`, `prettier`
Add kotlin language server support (#1725) * Add kotlin languageserver linter definition * Added kotlin languageserver references in docs, fix missing !! on other linters * Added Vader tests for root path detection in Kotlin Language Server
2018-07-15 17:54:18 +00:00
* Kotlin: `kotlinc`!!, `ktlint`!!, `languageserver`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* LaTeX (tex): `alex`!!, `chktex`, `lacheck`, `proselint`, `redpen`, `vale`, `write-good`
Fix #510 Support checking LESS files with stylelint
2017-11-12 12:09:19 +00:00
* Less: `lessc`, `prettier`, `stylelint`
Add llc integration for LLVM IR (#979) Check LLVM IR with llc
2017-10-10 09:13:09 +00:00
* LLVM: `llc`
Add a luac linter for Lua
2018-01-08 15:19:17 +00:00
* Lua: `luac`, `luacheck`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* Mail: `alex`!!, `proselint`, `vale`
Update doc/ale.txt & README.md
2017-10-24 12:09:56 +00:00
* Make: `checkmake`
Update document for textlint
2018-03-24 05:39:05 +00:00
* Markdown: `alex`!!, `markdownlint`!!, `mdl`, `prettier`, `proselint`, `redpen`, `remark-lint`, `textlint`, `vale`, `write-good`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* MATLAB: `mlint`
add documentation on mmc linter
2018-03-25 17:43:51 +00:00
* Mercury: `mmc`!!
Added NASM linter Added NASM linter (for nasm filetype).
2018-05-04 19:44:32 +00:00
* NASM: `nasm`!!
Use two exclamation marks for marking lint file linters, which are easier to see and click
2017-08-28 21:08:55 +00:00
* Nim: `nim check`!!
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* nix: `nix-instantiate`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* nroff: `alex`!!, `proselint`, `write-good`
Enabling clangd for cpp, objc and objcpp
2018-08-22 11:35:10 +00:00
* Objective-C: `clang`, `clangd`
* Objective-C++: `clang`, `clangd`
add ocamlformat support
2018-08-26 11:47:56 +00:00
* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols`, `ocamlformat`
add perltidy fixer
2018-04-21 13:09:38 +00:00
* Perl: `perl -c`, `perl-critic`, `perltidy`
Split Hack out from PHP, modernize fixes #1738 - Replace previous `hh_client` usage with LSP client - Add `HHAST` linter - Split Hack from PHP: Hack is increasingly diverging from PHP: - Hack tools do not understand PHP - Most PHP tools do not handle Hack code well (including vim's syntax highightling files) - http://github.com/hhvm/vim-hack now sets filetype to `hack`
2018-07-27 20:50:59 +00:00
* PHP: `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`, `php-cs-fixer`
add po support with proselint, writegood, msgfmt and alex
2018-01-27 11:40:40 +00:00
* PO: `alex`!!, `msgfmt`, `proselint`, `write-good`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* Pod: `alex`!!, `proselint`, `write-good`
functional pony linter
2018-02-10 19:04:43 +00:00
* Pony: `ponyc`
#1098 Add protoc-gen-lint to the list of supported tools
2017-11-10 09:43:42 +00:00
* proto: `protoc-gen-lint`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Pug: `pug-lint`
puppet: Add puppet-languageserver linter
2018-07-04 11:36:50 +00:00
* Puppet: `languageserver`, `puppet`, `puppet-lint`
doc: mark `vulture` as file linter
2018-07-26 12:41:13 +00:00
* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pyre`, `pylint`!!, `vulture`!!, `yapf`
Integration of qmlfmt linting tool (#1462) * Add first qmlfmt support * Add GetCommand() function - pass --error/-e option * Add handle unittest - fix pattern regex - store col as integer * Update docs * Add command callback unit test
2018-04-05 19:09:41 +00:00
* QML: `qmlfmt`, `qmllint`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* R: `lintr`
Add ocaml-language-server for OCaml and ReasonML
2017-11-11 18:27:41 +00:00
* ReasonML: `merlin`, `ols`, `refmt`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good`
redpen support for asciidoc, reST, LaTeX and Re:VIEW
2017-11-17 06:21:18 +00:00
* Re:VIEW: `redpen`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* RPM spec: `rpmlint`
Add solargraph LSP linter.
2018-08-24 04:02:51 +00:00
* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo`, `solargraph`
add rustfmt fixer
2017-10-21 17:31:49 +00:00
* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* SASS: `sass-lint`, `stylelint`
Sort some linter entries alphabetically
2017-11-12 12:11:15 +00:00
* SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint`
added sbtserver linter
2018-08-27 05:12:56 +00:00
* Scala: `fsc`, `sbtserver`, `scalac`, `scalafmt`, `scalastyle`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Slim: `slim-lint`
* SML: `smlnj`
Add fsc linter for Scala (#1452) * Add fsc as a Scala linter * Pull reused code into `autoload/ale/` directory * Include fsc into the README * Add unit test for testing the scala handler * Add unit test for scala's fsc linter * Rename scala unit tests for clarity * Fix typo in README * Fix typos in doc/ale.txt * Fix author headline * Put methods for fsc commands back into fsc.vim * Move command_callback tests to correct location * Rewrite handler test so it actually tests handler * Clarify description of test in test_scala_handler
2018-04-05 19:04:11 +00:00
* Solidity: `solhint`, `solium`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Stylus: `stylelint`
* SQL: `sqlint`
* Swift: `swiftlint`, `swiftformat`
Use two exclamation marks for marking lint file linters, which are easier to see and click
2017-08-28 21:08:55 +00:00
* Tcl: `nagelfar`!!
Add tflint fot Terraform
2017-10-26 18:32:33 +00:00
* Terraform: `tflint`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* Texinfo: `alex`!!, `proselint`, `write-good`
Update document for textlint
2018-03-24 05:39:05 +00:00
* Text^: `alex`!!, `proselint`, `redpen`, `textlint`, `vale`, `write-good`
Add a linter for Apache Thrift IDL files This linter works by invoking the `thrift` compiler with the buffer contents and reporting any parser and code generation issues. The handler rolls its own output-matching loop because we have the (unfortunate) requirement of handling error output that spans multiple lines. Unit tests cover both the command callback and handler, and there is initial documentation for all of the option variables.
2017-08-30 17:59:40 +00:00
* Thrift: `thrift`
Sort some linter entries alphabetically
2017-11-12 12:11:15 +00:00
* TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* Verilog: `iverilog`, `verilator`
* Vim: `vint`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* Vim help^: `alex`!!, `proselint`, `write-good`
vue: Add the vls language server linter
2018-07-05 12:04:20 +00:00
* Vue: `prettier`, `vls`
Make alex a file linter alex does not find its configuration file when using temporary files for input.
2017-12-18 14:26:52 +00:00
* XHTML: `alex`!!, `proselint`, `write-good`
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* XML: `xmllint`
Add prettier as a YAML option (#1789) * Add prettier as a yaml fixer * Sort yaml fixers alphabetically * Add prettier to doc/ale.txt * Add ale-yaml-prettier * Add ale-yaml-prettier to the TOC
2018-08-08 17:48:28 +00:00
* YAML: `prettier`, `swaglint`, `yamllint`
Add support for yang-lsp
2018-08-03 19:59:32 +00:00
* YANG: `yang-lsp`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
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/<filetype>/<filename>.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|
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
* On leaving insert mode. (off by default) - |g:ale_lint_on_insert_leave|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
* 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|
Fix a spelling mistake
2017-10-14 21:00:53 +00:00
* If ALE is used to check code manually. - |:ALELint|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
*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|.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
*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|
Fix a spelling mistake
2017-10-14 21:00:53 +00:00
* If ALE is used to check code manually. - |:ALELint|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
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 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
Add an FAQ entry explaining how to configure ALE for different buffers.
2017-11-19 13:56:09 +00:00
project configuration files. Buffer-local settings can also be used in
ftplugin files for different filetypes.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Fix #1610 - Encourage the use of ftplugin files more
2018-05-30 20:10:37 +00:00
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|
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
===============================================================================
4. Fixing Problems *ale-fix*
Add information that ALEFix can now accept arguments
2018-04-17 23:59:16 +00:00
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.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
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, or a |Dictionary| for describing a command to be
run in the background.
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.
Add support for post-processing fixer output
2017-11-22 22:32:53 +00:00
`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.
Fix #1086 - Implement command chaining for fixers
2017-11-07 23:20:14 +00:00
`chain_with` An optional key for defining a callback to call next.
The callback must accept two or three arguments,
`(buffer, output)` or `(buffer, output, input)` .
Functions receiving a variable number of arguments will
only receive the first two values. The `output` argument
will contain the lines of output from the command run.
The `input` argument is the List of lines for the
buffer, after applying any previous fixers.
The callback must return the same values returned for
any fixer function. This allows fixer functions to be
chained recursively.
When the command string returned for a fixer is an empty
string, the next command in the chain will still be run.
This allows commands to be skipped, like version checks
that are cached. An empty List will be passed to the
next callback in the chain for the `output`.
Disable piping buffer data into commands for fixing files where needed
2017-11-22 13:01:13 +00:00
`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 `0` when `chain_with` is defined
as anything other than `v:null`, and defaults to `1`
otherwise. This is so earlier commands in a chain
do not receive the buffer's data by default.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
*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.
#1108 Support selecting fixers with Lists
2017-11-11 23:04:08 +00:00
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
<
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
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 <F8> <Plug>(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.
===============================================================================
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
5. Language Server Protocol Support *ale-lsp*
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
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.
doc: LSP can provide completions
2018-08-05 05:38:16 +00:00
ALE supports the following LSP/tsserver features:
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
1. Diagnostics/linting - Enabled via selecting linters as usual.
doc: LSP can provide completions
2018-08-05 05:38:16 +00:00
2. Completion
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
3. Go to definition
-------------------------------------------------------------------------------
5.1 Completion *ale-completion*
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
ALE offers limited support for automatic completion of code while you type.
doc: LSP can provide completions
2018-08-05 05:38:16 +00:00
Completion is only supported while at least one LSP linter is enabled. ALE
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
will only suggest symbols provided by the LSP servers.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Suggestions will be made while you type after completion is enabled.
Completion can be enabled by setting |g:ale_completion_enabled| to `1`. 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|.
Add g:ale_completion_excluded_words for completion filtering
2018-05-03 10:17:41 +00:00
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|.
#1700 - Mention how to work around the completeopt bug in the documentation
2018-07-31 19:34:37 +00:00
*ale-completion-completopt-bug*
ALE implements completion as you type by temporarily adjusting |completeopt|
before opening the omnicomplete menu with <C-x><C-o>. 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
<
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
-------------------------------------------------------------------------------
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.
Add support for finding references using LSP servers or tsserver
2018-04-22 18:49:24 +00:00
-------------------------------------------------------------------------------
5.3 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
Fix a typo
2018-04-22 19:32:39 +00:00
supported:
Add support for finding references using LSP servers or tsserver
2018-04-22 18:49:24 +00:00
|ALEFindReferences| - Find references for the word under the cursor.
#1428 Show multiline hover messages, and document the new command
2018-04-24 20:03:06 +00:00
-------------------------------------------------------------------------------
5.4 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.
Clean up grammar for hover documentation a little
2018-05-30 18:44:01 +00:00
If |b: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.
Documentation : document the mouseover magic This first try is focused on fitting the information in existing paragraphs
2018-05-17 08:57:04 +00:00
#1428 Show multiline hover messages, and document the new command
2018-04-24 20:03:06 +00:00
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
===============================================================================
6. Global Options *ale-options*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |Number|
Default: `1`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
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|.
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #1176 - Add an option for caching failing executable checks
2017-11-30 10:34:51 +00:00
g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures*
Type: |Number|
#1524 - Define global variables where they are needed
2018-05-28 18:19:20 +00:00
Default: undefined
Fix #1176 - Add an option for caching failing executable checks
2017-11-30 10:34:51 +00:00
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.
#309 Add an option for changing the sign column color when problems are detected
2017-05-21 21:42:27 +00:00
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.
Fix a minor typo
2017-05-21 21:46:22 +00:00
`ALESignColumnWithoutErrors` - Uses the value for `SignColumn` by default.
#309 Add an option for changing the sign column color when problems are detected
2017-05-21 21:42:27 +00:00
#678 - Document the sign column color behaviour
2017-06-23 11:00:33 +00:00
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.
#309 Add an option for changing the sign column color when problems are detected
2017-05-21 21:42:27 +00:00
Fix #1115 - Add support for wrapping all commands with an option
2017-12-20 12:20:38 +00:00
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.
Document completion support for ALE, and expand the fixer documentation a little
2017-08-17 23:08:58 +00:00
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.
See |ale-completion|
Add g:ale_completion_excluded_words for completion filtering
2018-05-03 10:17:41 +00:00
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']
<
Document completion support for ALE, and expand the fixer documentation a little
2017-08-17 23:08:58 +00:00
g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
Type: |Number|
Increase the default maximum completion suggestions to a more useful but safe level, and filter before requesting details, which is faster
2017-08-18 21:34:18 +00:00
Default: `50`
Document completion support for ALE, and expand the fixer documentation a little
2017-08-17 23:08:58 +00:00
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.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_echo_cursor *g:ale_echo_cursor*
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |Number|
Default: `1`
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
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 behaviour.
The format of the message can be customizable in |g:ale_echo_msg_format|.
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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|.
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
#965 - Make the cursor echo delay configurable
2017-10-12 22:25:41 +00:00
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 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.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_echo_msg_error_str *g:ale_echo_msg_error_str*
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |String|
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
Default: `'Error'`
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
The string used for `%severity%` for errors. See |g:ale_echo_msg_format|
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_echo_msg_format *g:ale_echo_msg_format*
Make the message formats configurable with buffer local variables
2017-11-19 23:44:02 +00:00
b:ale_echo_msg_format *b:ale_echo_msg_format*
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |String|
#852 Support formatting echo messages with error codes. No linters set the `code` key yet
2017-11-13 00:47:34 +00:00
Default: `'%code: %%s'`
Fix #87 - Allow linter filetypes to be aliased
2016-10-11 22:11:45 +00:00
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
This variable defines a message format for echoed messages. The following
sequences of characters will be replaced.
#852 Support formatting echo messages with error codes. No linters set the `code` key yet
2017-11-13 00:47:34 +00:00
`%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
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
The strings for `%severity%` can be configured with the following options.
|g:ale_echo_msg_error_str| - Defaults to `'Error'`
Fix #1069 Support formatting the loclist messages with g:ale_loclist_msg_format
2017-11-14 10:28:36 +00:00
|g:ale_echo_msg_info_str| - Defaults to `'Info'`
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
|g:ale_echo_msg_warning_str| - Defaults to `'Warning'`
#852 Support formatting echo messages with error codes. No linters set the `code` key yet
2017-11-13 00:47:34 +00:00
`%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.
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
|g:ale_echo_cursor| needs to be set to 1 for messages to be displayed.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make the message formats configurable with buffer local variables
2017-11-19 23:44:02 +00:00
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.)
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Add support for showing Info severities in echoed messages
2017-11-12 23:19:26 +00:00
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|
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |String|
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
Default: `'Warning'`
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Update the documentation for the echo message format, so it makes more sense
2017-11-12 23:01:11 +00:00
The string used for `%severity%` for warnings. See |g:ale_echo_msg_format|
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #325 - document the ALEToggle option
2017-02-12 19:26:18 +00:00
g:ale_enabled *g:ale_enabled*
Fix #371 Allow ALE to be disabled in different buffers
2017-05-26 15:20:17 +00:00
*b:ale_enabled*
Fix #325 - document the ALEToggle option
2017-02-12 19:26:18 +00:00
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.
Fix #371 Allow ALE to be disabled in different buffers
2017-05-26 15:20:17 +00:00
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.
Fix #325 - document the ALEToggle option
2017-02-12 19:26:18 +00:00
Document ALEFix
2017-05-20 18:01:12 +00:00
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.
Fix typos
2017-10-02 16:11:54 +00:00
This variable can be overridden with variables in each buffer.
#1108 Support selecting fixers with Lists
2017-11-11 23:04:08 +00:00
`b:ale_fixers` can be set to a |List| of callbacks instead, which can be
more convenient.
Document ALEFix
2017-05-20 18:01:12 +00:00
Close #1417 - Support wildcard filetypes for fixers
2018-06-21 00:21:11 +00:00
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']}
<
Document ALEFix
2017-05-20 18:01:12 +00:00
#591 Support fixing files on save
2017-05-30 20:32:51 +00:00
g:ale_fix_on_save *g:ale_fix_on_save*
#857 - Add b:ale_fix_on_save for controlling fixing on save for specific buffers
2017-10-30 22:19:57 +00:00
b:ale_fix_on_save *b:ale_fix_on_save*
#591 Support fixing files on save
2017-05-30 20:32:51 +00:00
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
Fix typo
2017-06-08 15:43:28 +00:00
to the file will be saved to the file on disk.
#591 Support fixing files on save
2017-05-30 20:32:51 +00:00
#857 - Add b:ale_fix_on_save for controlling fixing on save for specific buffers
2017-10-30 22:19:57 +00:00
Fixing files can be disabled or enabled for individual buffers by setting
`b:ale_fix_on_save` to `0` or `1`.
#591 Support fixing files on save
2017-05-30 20:32:51 +00:00
Add an option for completely disabling command history, and add documentation
2017-02-16 21:33:44 +00:00
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.
#254 Add an option for logging the output of commands
2017-02-16 23:18:57 +00:00
g:ale_history_log_output *g:ale_history_log_output*
Type: |Number|
Store the output of commands by default so I don't have to ask people to turn it on any more.
2017-07-03 23:16:53 +00:00
Default: `1`
#254 Add an option for logging the output of commands
2017-02-16 23:18:57 +00:00
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.
Store the output of commands by default so I don't have to ask people to turn it on any more.
2017-07-03 23:16:53 +00:00
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.
#254 Add an option for logging the output of commands
2017-02-16 23:18:57 +00:00
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
g:ale_keep_list_window_open *g:ale_keep_list_window_open*
Fix #271 - Add the ability to open the quickfix or loclist windows only after saving a file
2017-08-07 23:46:42 +00:00
*b:ale_keep_list_window_open*
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Type: |Number|
Default: `0`
Fix #1306 - Tell users how to automatically close the loclist window in the documentation
2018-02-25 12:43:13 +00:00
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.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Document completion support for ALE, and expand the fixer documentation a little
2017-08-17 23:08:58 +00:00
See |g:ale_open_list|
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Fix #499 Set an explicit height for the quickfix list, and make the height configurable
2017-06-01 09:39:21 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_lint_delay *g:ale_lint_delay*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `200`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
This variable controls the milliseconds delay after which the linters will
be run after text is changed. This option is only meaningful with the
Add options to facilitate linting only in normal mode (#425) * [#420] Add options to facilitate linting only in normal mode ale_lint_on_text_changed: Allow setting to 'insert' or 'normal' to lint when text is changed only in insert or normal mode respectively. ale_lint_on_insert_leave: This flag can be set to 1 to enable linting when leaving insert mode. * [#420] Test updated global options Ale should - bind to TextChanged events when g:ale_lint_on_text_changed = 1 - bind to TextChanged events when g:ale_lint_on_text_changed = 'always' - bind to InsertLeave event when g:ale_lint_on_insert_leave = 1
2017-03-30 22:21:37 +00:00
|g:ale_lint_on_text_changed| variable set to `always`, `insert`, or `normal`.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_lint_on_enter *g:ale_lint_on_enter*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `1`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #687 - Check files on enter if they have changed
2017-06-24 11:24:31 +00:00
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.
#653 Document the automatic error prompt closing behaviour
2017-08-20 12:35:27 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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|.
Fix #687 - Check files on enter if they have changed
2017-06-24 11:24:31 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #130 - Run linters when the filetype is changed
2017-03-27 21:40:25 +00:00
g:ale_lint_on_filetype_changed *g:ale_lint_on_filetype_changed*
Type: |Number|
Default: `1`
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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.
Fix #130 - Run linters when the filetype is changed
2017-03-27 21:40:25 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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|.
#505 - Do not lint files on enter if the option for linting when the filetype changed is on
2017-09-02 15:57:01 +00:00
Fix #130 - Run linters when the filetype is changed
2017-03-27 21:40:25 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_lint_on_save *g:ale_lint_on_save*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Enabling linting on save by default, re #333
2017-03-27 19:36:35 +00:00
Default: `1`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
Add options to facilitate linting only in normal mode (#425) * [#420] Add options to facilitate linting only in normal mode ale_lint_on_text_changed: Allow setting to 'insert' or 'normal' to lint when text is changed only in insert or normal mode respectively. ale_lint_on_insert_leave: This flag can be set to 1 to enable linting when leaving insert mode. * [#420] Test updated global options Ale should - bind to TextChanged events when g:ale_lint_on_text_changed = 1 - bind to TextChanged events when g:ale_lint_on_text_changed = 'always' - bind to InsertLeave event when g:ale_lint_on_insert_leave = 1
2017-03-30 22:21:37 +00:00
Type: |String|
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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.
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|.
Add options to facilitate linting only in normal mode (#425) * [#420] Add options to facilitate linting only in normal mode ale_lint_on_text_changed: Allow setting to 'insert' or 'normal' to lint when text is changed only in insert or normal mode respectively. ale_lint_on_insert_leave: This flag can be set to 1 to enable linting when leaving insert mode. * [#420] Test updated global options Ale should - bind to TextChanged events when g:ale_lint_on_text_changed = 1 - bind to TextChanged events when g:ale_lint_on_text_changed = 'always' - bind to InsertLeave event when g:ale_lint_on_insert_leave = 1
2017-03-30 22:21:37 +00:00
g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave*
Type: |Number|
Default: `0`
#1121 Tell people how to lint when leaving insert mode with Ctrl+C
2017-11-13 10:27:20 +00:00
When set to `1` in your vimrc file, this option will cause ALE to run
linters when you leave insert mode.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
#1121 Tell people how to lint when leaving insert mode with Ctrl+C
2017-11-13 10:27:20 +00:00
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 keybind. >
" Make using Ctrl+C do the same as Escape, to trigger autocmd commands
inoremap <C-c> <Esc>
<
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
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|.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_linter_aliases *g:ale_linter_aliases*
#427 Allow linters and aliases to be configured in buffer local variables
2017-04-25 22:52:13 +00:00
*b:ale_linter_aliases*
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
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: >
{
#1600 Alias vimwiki to markdown
2018-05-26 10:41:52 +00:00
\ 'Dockerfile': 'dockerfile',
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
\ 'csh': 'sh',
#1600 Alias vimwiki to markdown
2018-05-26 10:41:52 +00:00
\ 'plaintex': 'tex',
\ 'systemverilog': 'verilog',
#1674 - Alias verilog_systemverilog to verilog by default
2018-06-23 17:20:39 +00:00
\ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
#1600 Alias vimwiki to markdown
2018-05-26 10:41:52 +00:00
\ 'vimwiki': 'markdown',
\ 'zsh': 'sh',
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
\}
<
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.
Add support for multiple filetypes in filetype aliasing
2017-04-11 20:10:08 +00:00
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
Fix a typo
2017-11-11 14:27:53 +00:00
will override the original linters for the aliased filetype.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
#427 Allow linters and aliases to be configured in buffer local variables
2017-04-25 22:52:13 +00:00
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.
#1108 Support setting b:ale_linter_aliases to a List
2017-11-12 00:11:50 +00:00
`b:ale_linter_aliases` can be set to a |List|, to tell ALE to load the
linters for specific filetypes for a given buffer. >
let b:ale_linter_aliases = ['html', 'javascript', 'css']
<
No linters will be loaded when the buffer's filetype is empty.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
#427 Allow linters and aliases to be configured in buffer local variables
2017-04-25 22:52:13 +00:00
g:ale_linters *g:ale_linters*
*b:ale_linters*
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Type: |Dictionary|
Default: `{}`
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
The |g:ale_linters| option sets a |Dictionary| mapping a filetype to a
|List| of linter programs to be run when checking particular filetypes.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
This |Dictionary| will be merged with a default dictionary containing the
following values: >
{
\ 'csh': ['shell'],
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
\ 'go': ['gofmt', 'golint', 'go vet'],
Disable HHAST by default it executes $PROJECT/vendor/bin/hhast, so that's not a good idea.
2018-08-02 20:09:51 +00:00
\ 'hack': ['hack'],
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
\ 'help': [],
Fix #1186 - Disable checking code with perl by default
2017-12-02 20:43:47 +00:00
\ 'perl': ['perlcritic'],
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
\ 'python': ['flake8', 'mypy', 'pylint'],
Fix #319 - Enable only cargo for Rust by default
2017-02-15 22:59:26 +00:00
\ 'rust': ['cargo'],
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
\ 'spec': [],
Fix #319 - Enable only cargo for Rust by default
2017-02-15 22:59:26 +00:00
\ 'text': [],
\ 'zsh': ['shell'],
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
\}
<
This option can be used to enable only a particular set of linters for a
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
file. For example, you can enable only `eslint` for JavaScript files: >
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
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': []}
<
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
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. >
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
let g:ale_linters = {'c': 'all'}
<
#427 Allow linters and aliases to be configured in buffer local variables
2017-04-25 22:52:13 +00:00
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,
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
then `g:ale_linters`, and then the default Dictionary mentioned above.
#427 Allow linters and aliases to be configured in buffer local variables
2017-04-25 22:52:13 +00:00
#1108 Support using Lists and 'all' for b:ale_linters
2017-11-11 23:55:04 +00:00
`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'
<
Fix #1128 - Add g:ale_linters_explicit for only enabling linters explicitly
2017-11-14 19:55:28 +00:00
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.
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Close #1453 #1172 - Add ale_linters_ignore for ignoring linter results
2018-06-24 20:16:45 +00:00
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']
<
Option to open lists vertically (#1381) * Add configuration option to open lists vertically * Add tests, clean up vertical list config * Vertical list option cleanup * Use is# for tests * Order properties in documentation alphabetically
2018-03-02 20:22:29 +00:00
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|)
Fix #1069 Support formatting the loclist messages with g:ale_loclist_msg_format
2017-11-14 10:28:36 +00:00
g:ale_loclist_msg_format *g:ale_loclist_msg_format*
Make the message formats configurable with buffer local variables
2017-11-19 23:44:02 +00:00
b:ale_loclist_msg_format *b:ale_loclist_msg_format*
Fix #1069 Support formatting the loclist messages with g:ale_loclist_msg_format
2017-11-14 10:28:36 +00:00
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.
Add an option for completely disabling command history, and add documentation
2017-02-16 21:33:44 +00:00
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|.
#965 - Support limiting the number of signs ALE will set
2017-10-12 22:04:46 +00:00
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|.
Fix #577 Add an option preventing linting of large files
2017-05-26 20:21:15 +00:00
g:ale_maximum_file_size *g:ale_maximum_file_size*
*b:ale_maximum_file_size*
Type: |Number|
#1524 - Define global variables where they are needed
2018-05-28 18:19:20 +00:00
Default: undefined
Fix #577 Add an option preventing linting of large files
2017-05-26 20:21:15 +00:00
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.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
g:ale_open_list *g:ale_open_list*
Fix #271 - Add the ability to open the quickfix or loclist windows only after saving a file
2017-08-07 23:46:42 +00:00
*b:ale_open_list*
Type: |Number| or |String|
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Default: `0`
Fix #271 - Add the ability to open the quickfix or loclist windows only after saving a file
2017-08-07 23:46:42 +00:00
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.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
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
Fix #1306 - Tell users how to automatically close the loclist window in the documentation
2018-02-25 12:43:13 +00:00
to `1`, in which case the window will be kept open when no problems are
found.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Fix #499 Set an explicit height for the quickfix list, and make the height configurable
2017-06-01 09:39:21 +00:00
The window size can be configured with |g:ale_list_window_size|.
Option to open lists vertically (#1381) * Add configuration option to open lists vertically * Add tests, clean up vertical list config * Vertical list option cleanup * Use is# for tests * Order properties in documentation alphabetically
2018-03-02 20:22:29 +00:00
Windows can be opened vertically with |g:ale_list_vertical|.
Fix #1306 - Tell users how to automatically close the loclist window in the documentation
2018-02-25 12:43:13 +00:00
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
<
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
g:ale_pattern_options *g:ale_pattern_options*
Type: |Dictionary|
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
Default: undefined
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
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: >
#1108 Support selecting fixers with Lists
2017-11-11 23:04:08 +00:00
" Use just ESLint for linting and fixing files which end in '.foo.js'
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
let g:ale_pattern_options = {
\ '\.foo\.js$': {
#1108 Support using Lists and 'all' for b:ale_linters
2017-11-11 23:55:04 +00:00
\ 'ale_linters': ['eslint'],
Fix a typo in the documentation
2018-03-26 08:19:58 +00:00
\ 'ale_fixers': ['eslint'],
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
\ },
\}
<
#1108 Support selecting fixers with Lists
2017-11-11 23:04:08 +00:00
See |b:ale_linters| and |b:ale_fixers| for information for those options.
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
Filenames are matched with |match()|, and patterns depend on the |magic|
Fix a typo in the documentation
2018-02-26 17:04:54 +00:00
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
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
filename will be used for matching, taken from `expand('%:p')`.
#1095 Apply all patterns for g:ale_pattern_options, instead of just the first match
2017-11-11 13:44:05 +00:00
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`.
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
Type: |Number|
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
Default: undefined
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
Fix #1619 - Rewrite lint on enter events so they behave better
2018-07-16 23:18:20 +00:00
This option can be used for disabling pattern options. If set to `0`, ALE
will not set buffer variables per |g:ale_pattern_options|.
#371 Allow buffer variables to be set based on patterns
2017-05-26 14:59:43 +00:00
Fix #537 - Add support for balloons
2017-05-31 21:04:33 +00:00
g:ale_set_balloons *g:ale_set_balloons*
Fix #1404 - Do not show balloons when g:ale_set_balloons is 0. Add b:ale_set_balloons
2018-03-25 11:57:08 +00:00
*b:ale_set_balloons*
Fix #537 - Add support for balloons
2017-05-31 21:04:33 +00:00
Type: |Number|
Fix #1631 - Disable balloon support for terminals by default
2018-07-20 15:10:25 +00:00
Default: `has('balloon_eval') && has('gui_running')`
Fix #537 - Add support for balloons
2017-05-31 21:04:33 +00:00
When this option is set to `1`, balloon messages will be displayed for
Clean up grammar for hover documentation a little
2018-05-30 18:44:01 +00:00
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.
Fix #1404 - Do not show balloons when g:ale_set_balloons is 0. Add b:ale_set_balloons
2018-03-25 11:57:08 +00:00
Fix #1631 - Disable balloon support for terminals by default
2018-07-20 15:10:25 +00:00
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.
Fix #1404 - Do not show balloons when g:ale_set_balloons is 0. Add b:ale_set_balloons
2018-03-25 11:57:08 +00:00
`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.
Fix #537 - Add support for balloons
2017-05-31 21:04:33 +00:00
Clean up grammar for hover documentation a little
2018-05-30 18:44:01 +00:00
Balloons will not be shown when |g:ale_enabled| or |b:ale_enabled| is `0`.
Fix #537 - Add support for balloons
2017-05-31 21:04:33 +00:00
Do not echo messages to the echo line for mouse movements unless the user says so
2018-05-17 15:23:29 +00:00
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.
Fix #171 - Implement basic error highlighting
2017-02-13 00:18:51 +00:00
g:ale_set_highlights *g:ale_set_highlights*
Type: |Number|
Default: `has('syntax')`
#149 - Set different highlights for info, style error, and style warning problems
2017-05-21 18:22:48 +00:00
When this option is set to `1`, highlights will be set for problems.
ALE will use the following highlight groups for problems:
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
|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'`
Fix #171 - Implement basic error highlighting
2017-02-13 00:18:51 +00:00
Fix #741 - Set highlights for entire lines when signs are disabled
2017-11-17 14:29:51 +00:00
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.
Fix #171 - Implement basic error highlighting
2017-02-13 00:18:51 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_set_loclist *g:ale_set_loclist*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `1`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
When this option is set to `1`, the |loclist| will be populated with any
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
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|.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
g:ale_set_quickfix *g:ale_set_quickfix*
Type: |Number|
Default: `0`
Update the documentation to mention the new behaviour for quickfix
2017-08-19 13:35:01 +00:00
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.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
#1316 Mention that the quickfix list option shouldn't be used with :cfdo
2018-01-25 14:54:33 +00:00
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.
Document the new quickfix and loclist options.
2017-01-22 15:19:09 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_set_signs *g:ale_set_signs*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `has('signs')`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
When this option is set to `1`, the |sign| column will be populated with
#149 - Support Info, style error, and style warning types for problems for signs
2017-05-20 22:32:41 +00:00
signs marking where problems appear in the file.
ALE will use the following highlight groups for problems:
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
|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'`
#149 - Support Info, style error, and style warning types for problems for signs
2017-05-20 22:32:41 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
#965 - Support limiting the number of signs ALE will set
2017-10-12 22:04:46 +00:00
To limit the number of signs ALE will set, see |g:ale_max_signs|.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_sign_column_always *g:ale_sign_column_always*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `0`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_sign_error *g:ale_sign_error*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |String|
Default: `'>>'`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
#149 - Support Info, style error, and style warning types for problems for signs
2017-05-20 22:32:41 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_sign_offset *g:ale_sign_offset*
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `1000000`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
g:ale_sign_warning *g:ale_sign_warning*
Echo string format (#76) * Implement an option to configure the echoed message, #48 Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s' * Add new options for defining the string used for errors in echoed message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str` * Change text output of some linters Now that the echoed message can be customized, no need to add the type to the text variable. * Update README & documentation file * Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options) * Added echo warning str option to the doc
2016-10-10 11:53:54 +00:00
Type: |String|
Sort the global options in the documentation by name.
2017-01-22 15:06:33 +00:00
Default: `'--'`
Echo string format (#76) * Implement an option to configure the echoed message, #48 Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s' * Add new options for defining the string used for errors in echoed message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str` * Change text output of some linters Now that the echoed message can be customized, no need to add the type to the text variable. * Update README & documentation file * Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options) * Added echo warning str option to the doc
2016-10-10 11:53:54 +00:00
#149 - Support Info, style error, and style warning types for problems for signs
2017-05-20 22:32:41 +00:00
The sign for warnings in the sign gutter.
Echo string format (#76) * Implement an option to configure the echoed message, #48 Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s' * Add new options for defining the string used for errors in echoed message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str` * Change text output of some linters Now that the echoed message can be customized, no need to add the type to the text variable. * Update README & documentation file * Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options) * Added echo warning str option to the doc
2016-10-10 11:53:54 +00:00
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
g:ale_type_map *g:ale_type_map*
*b:ale_type_map*
Type: |Dictionary|
Default: `{}`
Make the grammar a little better for the g:ale_type_map option
2017-09-03 19:12:45 +00:00
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:
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
`'E'` - `{'type': 'E'}`
`'ES'` - `{'type': 'E', 'sub_type': 'style'}`
`'W'` - `{'type': 'W'}`
`'WS'` - `{'type': 'W', 'sub_type': 'style'}`
`'I'` - `{'type': 'I'}`
Make the grammar a little better for the g:ale_type_map option
2017-09-03 19:12:45 +00:00
For example, if you want to turn flake8 errors into warnings, you can write
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
the following: >
Fix documentation typo
2017-07-11 22:14:18 +00:00
let g:ale_type_map = {'flake8': {'ES': 'WS', 'E': 'W'}}
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
<
If you wanted to turn style errors and warnings into regular errors and
Make the grammar a little better for the g:ale_type_map option
2017-09-03 19:12:45 +00:00
warnings, you can write the following: >
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
Fix documentation typo
2017-07-11 22:14:18 +00:00
let g:ale_type_map = {'flake8': {'ES': 'E', 'WS': 'W'}}
Fix #536 - Implement linter problem type re-mapping
2017-06-14 16:59:13 +00:00
<
Type maps can be set per-buffer with `b:ale_type_map`.
Close #542 - Add an option for disabling running locally installed executables by default
2018-04-09 18:11:20 +00:00
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.
Document the virtualenv directories variable in the main file instead
2017-07-08 13:30:12 +00:00
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names*
Type: |List|
Update the Python documentation
2018-07-15 18:26:45 +00:00
Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']`
Document the virtualenv directories variable in the main file instead
2017-07-08 13:30:12 +00:00
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.
Allow warnings about trailing blank lines to be hidden for flake8 and pycodestyle
2017-11-28 10:08:34 +00:00
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|.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace*
#427 Document that the trailing whitespace option can be set differently in each buffer
2017-05-07 16:17:00 +00:00
b:ale_warn_about_trailing_whitespace *b:ale_warn_about_trailing_whitespace*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Up-indent types and defaults, and align markers
2016-10-09 20:23:34 +00:00
Type: |Number|
Default: `1`
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
When this option is set to `1`, warnings relating to trailing whitespace on
Allow warnings about trailing blank lines to be hidden for flake8 and pycodestyle
2017-11-28 10:08:34 +00:00
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`.
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
#427 Document that the trailing whitespace option can be set differently in each buffer
2017-05-07 16:17:00 +00:00
This option may be configured on a per buffer basis.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #895 - Run Node.js scripts with node.exe instead of node on Windows
2017-08-31 12:12:24 +00:00
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.
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
-------------------------------------------------------------------------------
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
6.1. Highlights *ale-highlights*
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
ALEError *ALEError*
Default: `highlight link ALEError SpellBad`
The highlight used for highlighted errors. See |g:ale_set_highlights|.
ALEErrorLine *ALEErrorLine*
Default: Undefined
Fix #741 - Set highlights for entire lines when signs are disabled
2017-11-17 14:29:51 +00:00
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|.
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
ALEErrorSign *ALEErrorSign*
Default: `highlight link ALEErrorSign error`
The highlight used for error signs. See |g:ale_set_signs|.
ALEInfo *ALEInfo.*
*ALEInfo-highlight*
Default: `highlight link ALEInfo ALEWarning`
The highlight used for highlighted info messages. See |g:ale_set_highlights|.
ALEInfoSign *ALEInfoSign*
Default: `highlight link ALEInfoSign ALEWarningSign`
The highlight used for info message signs. See |g:ale_set_signs|.
ALEInfoLine *ALEInfoLine*
Default: Undefined
Fix #741 - Set highlights for entire lines when signs are disabled
2017-11-17 14:29:51 +00:00
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|.
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
ALEStyleError *ALEStyleError*
Default: `highlight link ALEStyleError ALEError`
The highlight used for highlighted style errors. See |g:ale_set_highlights|.
ALEStyleErrorSign *ALEStyleErrorSign*
Default: `highlight link ALEStyleErrorSign ALEErrorSign`
The highlight used for style error signs. See |g:ale_set_signs|.
ALEStyleWarning *ALEStyleWarning*
Default: `highlight link ALEStyleWarning ALEError`
The highlight used for highlighted style warnings. See |g:ale_set_highlights|.
ALEStyleWarningSign *ALEStyleWarningSign*
Default: `highlight link ALEStyleWarningSign ALEWarningSign`
The highlight used for style warning signs. See |g:ale_set_signs|.
ALEWarning *ALEWarning*
Default: `highlight link ALEWarning SpellCap`
The highlight used for highlighted warnings. See |g:ale_set_highlights|.
ALEWarningLine *ALEWarningLine*
Default: Undefined
Fix #741 - Set highlights for entire lines when signs are disabled
2017-11-17 14:29:51 +00:00
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|.
#171 - Document every highlight
2017-06-26 20:49:13 +00:00
ALEWarningSign *ALEWarningSign*
Default: `highlight link ALEWarningSign todo`
The highlight used for warning signs. See |g:ale_set_signs|.
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
-------------------------------------------------------------------------------
6.2. Options for write-good *ale-write-good-options*
The options for the write-good linter are global because it does not make
sense to have them specified on a per-language basis.
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|
Close #542 - Add an option for disabling running locally installed executables by default
2018-04-09 18:11:20 +00:00
Default: `get(g:, 'ale_use_global_executables', 0)`
Fix #643 - Add support for write-good for many languages
2017-10-24 23:27:40 +00:00
See |ale-integrations-local-executables|
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
7. Integration Documentation *ale-integrations*
Add support for changing the eslint executable.
2016-10-06 12:42:52 +00:00
Support both prettier and prettier-eslint
2017-05-27 17:31:52 +00:00
Linter and fixer options are documented in individual help files. See the
table of contents at |ale-contents|.
Add support for changing the eslint executable.
2016-10-06 12:42:52 +00:00
Support both prettier and prettier-eslint
2017-05-27 17:31:52 +00:00
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`.
#427 Document the buffer variables, at least slightly
2017-04-19 22:55:55 +00:00
#659 - Add options for Python fixers, and cut down on duplicated documentation
2017-06-18 10:03:31 +00:00
*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
<
Close #542 - Add an option for disabling running locally installed executables by default
2018-04-09 18:11:20 +00:00
|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.
#659 - Add options for Python fixers, and cut down on duplicated documentation
2017-06-18 10:03:31 +00:00
The option |g:ale_virtualenv_dir_names| controls the local virtualenv paths
ALE will use to search for Python executables.
Add support for Rust using rustc and cargo (#230) * Add rustc checker for rust files * Add documentation for rustc * Use a nice helper function * Add cargo as linter * Complete the doc for rust linters * Put l: in front of every local variable * Apply the requested stylistic changes
2017-01-12 09:33:55 +00:00
Add support for changing the eslint executable.
2016-10-06 12:42:52 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
8. Commands/Keybinds *ale-commands*
Document ALEFix
2017-05-20 18:01:12 +00:00
Add support for finding references using LSP servers or tsserver
2018-04-22 18:49:24 +00:00
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 (`<CR>`) 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.
#1236 Explain how to use Vim jumps
2018-04-23 20:18:58 +00:00
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|.
Add support for finding references using LSP servers or tsserver
2018-04-22 18:49:24 +00:00
A plug mapping `<Plug>(ale_find_references)` is defined for this command.
Document ALEFix
2017-05-20 18:01:12 +00:00
ALEFix *ALEFix*
Fix problems with the current buffer. See |ale-fix| for more information.
Document the <Plug>(ale_fix) mapping
2017-06-01 20:13:05 +00:00
A plug mapping `<Plug>(ale_fix)` is defined for this command.
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
Use a new window for the ALEFixSuggest command, and document it better
2017-06-28 15:20:01 +00:00
ALEFixSuggest *ALEFixSuggest*
Suggest tools that can be used to fix problems in the current buffer.
See |ale-fix| for more information.
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
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.
#1236 Explain how to use Vim jumps
2018-04-23 20:18:58 +00:00
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|.
Document go to definition support and put that and completion in an LSP section
2017-11-26 23:02:51 +00:00
A plug mapping `<Plug>(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 `<Plug>(ale_go_to_definition_in_tab)` is defined for this
command.
#1428 Show multiline hover messages, and document the new command
2018-04-24 20:03:06 +00:00
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 `<Plug>(ale_hover)` is defined for this command.
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
*:ALELint*
Fix #288 - Add a command for running ALE
2017-02-28 09:10:58 +00:00
ALELint *ALELint*
Run ALE once for the current buffer. This command can be used to run ALE
manually, instead of automatically, if desired.
#333 Change arguments for ale#Queue so they are more obvious, and check files in more places
2017-03-21 13:38:27 +00:00
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.
Fix #288 - Add a command for running ALE
2017-02-28 09:10:58 +00:00
A plug mapping `<Plug>(ale_lint)` is defined for this command.
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
ALEPrevious *ALEPrevious*
ALEPreviousWrap *ALEPreviousWrap*
ALENext *ALENext*
Add documentation for ALEDetail
2017-03-03 02:55:22 +00:00
ALENextWrap *ALENextWrap*
Add :ALEFirst and :ALELast commands (#616) * Add :ALEFirst and :ALELast commands * Add documentation for ALEFirst and ALELast commands * Add tests for ale#loclist_jumping#JumpToIndex() * Fix the loclist jumping tests
2017-06-03 11:45:52 +00:00
ALEFirst *ALEFirst*
ALELast *ALELast*
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
*ale-navigation-commands*
Make the navigation commands only work with ALE's pre-sorted list
2017-03-07 23:31:25 +00:00
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`.
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
`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.
doc: fix typo: s/the the/to the/
2017-06-05 15:06:48 +00:00
`ALEFirst` goes to the first error or warning in the buffer, while `ALELast`
Add :ALEFirst and :ALELast commands (#616) * Add :ALEFirst and :ALELast commands * Add documentation for ALEFirst and ALELast commands * Add tests for ale#loclist_jumping#JumpToIndex() * Fix the loclist jumping tests
2017-06-03 11:45:52 +00:00
goes to the last one.
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
The following |<Plug>| mappings are defined for the commands: >
<Plug>(ale_previous) - ALEPrevious
<Plug>(ale_previous_wrap) - ALEPreviousWrap
<Plug>(ale_next) - ALENext
<Plug>(ale_next_wrap) - ALENextWrap
Add :ALEFirst and :ALELast commands (#616) * Add :ALEFirst and :ALELast commands * Add documentation for ALEFirst and ALELast commands * Add tests for ale#loclist_jumping#JumpToIndex() * Fix the loclist jumping tests
2017-06-03 11:45:52 +00:00
<Plug>(ale_first) - ALEFirst
<Plug>(ale_last) - ALELast
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
<
For example, these commands could be bound to the keys Ctrl + j
and Ctrl + k: >
" Map movement through errors without wrapping.
nmap <silent> <C-k> <Plug>(ale_previous)
nmap <silent> <C-j> <Plug>(ale_next)
" OR map keys to use wrapping.
nmap <silent> <C-k> <Plug>(ale_previous_wrap)
nmap <silent> <C-j> <Plug>(ale_next_wrap)
<
Fix #325 - document the ALEToggle option
2017-02-12 19:26:18 +00:00
ALEToggle *ALEToggle*
Add :ALEEnable and :ALEDisable commands
2017-03-28 22:04:58 +00:00
ALEEnable *ALEEnable*
ALEDisable *ALEDisable*
#817 - Document the buffer toggling options, and define plug mappings for everything
2017-10-29 10:55:02 +00:00
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.
Fix #719 - Add ALEReset and ALEResetBuffer for removing problems for all buffers or one buffer
2017-10-29 17:03:29 +00:00
The following plug mappings are defined, for conveniently defining keybinds:
#817 - Document the buffer toggling options, and define plug mappings for everything
2017-10-29 10:55:02 +00:00
|ALEToggle| - `<Plug>(ale_toggle)`
|ALEEnable| - `<Plug>(ale_enable)`
|ALEDisable| - `<Plug>(ale_disable)`
|ALEToggleBuffer| - `<Plug>(ale_toggle_buffer)`
|ALEEnableBuffer| - `<Plug>(ale_enable_buffer)`
|ALEDisableBuffer| - `<Plug>(ale_disable_buffer)`
Fix #325 - document the ALEToggle option
2017-02-12 19:26:18 +00:00
Fix #719 - Add ALEReset and ALEResetBuffer for removing problems for all buffers or one buffer
2017-10-29 17:03:29 +00:00
For removing problems reported by ALE, but leaving ALE enabled, see
|ALEReset| and |ALEResetBuffer|.
Add documentation for ALEDetail
2017-03-03 02:55:22 +00:00
Update the documentation for :ALEDetail
2017-11-14 23:29:48 +00:00
*:ALEDetail*
Add documentation for ALEDetail
2017-03-03 02:55:22 +00:00
ALEDetail *ALEDetail*
#1398 document the detail key
2018-06-20 22:10:01 +00:00
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|.
Add documentation for ALEDetail
2017-03-03 02:55:22 +00:00
A plug mapping `<Plug>(ale_detail)` is defined for this command.
Document :ALEInfo better
2017-06-26 21:08:55 +00:00
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
*:ALEInfo*
Document :ALEInfo better
2017-06-26 21:08:55 +00:00
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.
Close #1439 - Add an :ALEInfoToFile command
2018-04-08 18:04:07 +00:00
`:ALEInfoToFile` will write the ALE runtime information to a given filename.
The filename works just like |:w|.
Document :ALEInfo better
2017-06-26 21:08:55 +00:00
Fix #719 - Add ALEReset and ALEResetBuffer for removing problems for all buffers or one buffer
2017-10-29 17:03:29 +00:00
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| - `<Plug>(ale_reset)`
|ALEResetBuffer| - `<Plug>(ale_reset_buffer)`
ALE can be disabled globally or for a buffer with |ALEDisable| or
|ALEDisableBuffer|.
Add a command for stopping all LSP clients
2018-03-06 10:23:49 +00:00
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.
#144 - Implement commands for moving through warnings/errors
2016-10-24 21:09:41 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
9. API *ale-api*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Massively reduce the amount of code needed for linter tests
2018-07-15 17:24:53 +00:00
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.
Document the extra optional argument for ale#Queue
2017-08-08 22:52:28 +00:00
ale#Queue(delay, [linting_flag, buffer_number]) *ale#Queue()*
#333 Pass in a flag indicating that linters should be run against files, and clear more jobs
2017-03-14 23:51:57 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
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
#333 Change arguments for ale#Queue so they are more obvious, and check files in more places
2017-03-21 13:38:27 +00:00
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.
#333 Pass in a flag indicating that linters should be run against files, and clear more jobs
2017-03-14 23:51:57 +00:00
Document the extra optional argument for ale#Queue
2017-08-08 22:52:28 +00:00
An optional `buffer_number` argument can be given for specifying the buffer
to check. The active buffer (`bufnr('')`) will be checked by default.
Fix #468 - Add a cool down period for when things go wrong
2017-08-08 23:05:55 +00:00
*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.
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
Fix #438 Create Java .class files for javac in a temporary directory
2017-03-31 19:14:53 +00:00
ale#engine#CreateDirectory(buffer) *ale#engine#CreateDirectory()*
Create a new temporary directory with a unique name, and manage that
Massively reduce the amount of code needed for linter tests
2018-07-15 17:24:53 +00:00
directory with |ale#engine#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#engine#CreateFile(buffer) *ale#engine#CreateFile()*
Create a new temporary file with a unique name, and manage that file with
|ale#engine#ManageFile()|, so it will be removed as soon as possible.
Fix #438 Create Java .class files for javac in a temporary directory
2017-03-31 19:14:53 +00:00
It is advised to only call this function from a callback function for
returning a linter command to run.
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
ale#engine#EscapeCommandPart(command_part) *ale#engine#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.
Merge everything into the one global map.
2016-10-24 19:21:32 +00:00
ale#engine#GetLoclist(buffer) *ale#engine#GetLoclist()*
Update the documentation for GetLoclist
2017-11-15 09:16:26 +00:00
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()|.
Merge everything into the one global map.
2016-10-24 19:21:32 +00:00
#1363 Make ale#engine#IsCheckingBuffer part of the public API
2018-02-25 12:57:54 +00:00
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.
Add support for managing temporary files/directories
2017-02-11 15:16:08 +00:00
ale#engine#ManageFile(buffer, filename) *ale#engine#ManageFile()*
Given a buffer number for a buffer currently running some linting tasks
and a filename, register a filename with ALE for automatic deletion after
linting 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 separetly with the |ale#engine#ManageDirectory| function.
ale#engine#ManageDirectory(buffer, directory) *ale#engine#ManageDirectory()*
Like |ale#engine#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#engine#ManageFile()| instead for deleting single
files.
Support fixer aliases, and make prettier-eslint and prettier-standard just work
2017-11-22 15:31:39 +00:00
ale#fix#registry#Add(name, func, filetypes, desc, [aliases])
*ale#fix#registry#Add()*
Document ALEFix
2017-05-20 18:01:12 +00:00
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.
Support fixer aliases, and make prettier-eslint and prettier-standard just work
2017-11-22 15:31:39 +00:00
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`.
Document ALEFix
2017-05-20 18:01:12 +00:00
First pass at optimizing ale to autoload (#80) * First pass at optimizing ale to autoload First off, the structure/function names should be revised a bit, but I will wait for @w0rp's input before unifying the naming style. Second off, the docs probably need some more work, I just did some simple find-and-replace work. With that said, this pull brings major performance gains for ale. On my slowest system, fully loading ale and all its code takes around 150ms. I have moved all of ale's autoload-able code to autoload/, and in addition, implemented lazy-loading of linters. This brings load time on that same system down to 5ms. The only downside of lazy loading is that `g:ale_linters` cannot be changed at runtime; however, it also speeds up performance at runtime by simplfying the logic greatly. Please let me know what you think! Closes #59 * Address Travis/Vint errors For some reason, ale isn't running vint for me... * Incorporate feedback, make fixes Lazy-loading logic is much improved. * Add header comments; remove incorrect workaround * Remove unneeded plugin guards * Fix lazy-loading linter logic Set the wrong variable.... * Fix capitialization
2016-10-10 18:51:29 +00:00
ale#linter#Define(filetype, linter) *ale#linter#Define()*
Clean up the documentation some more, and make the description of the ALELint autocmd clearer
2017-03-22 08:57:29 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
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.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
This argument is required, unless the linter is an
LSP linter. In which case, this argument must not be
Fix a typo in the documentation
2018-07-01 15:23:42 +00:00
defined, as LSP linters handle diagnostics
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
automatically. See |ale-lsp-linters|.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Handle linter callback functions being unknown or deleted
2018-07-13 08:47:26 +00:00
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.
Copy all loclist items returned from handlers, and set up defaults for convenience
2017-02-26 14:51:22 +00:00
The keys for each item in the List will be handled in
the following manner:
#739 - Document the end_col and end_lnum keys for the loclist format
2017-07-15 23:40:20 +00:00
*ale-loclist-format*
Copy all loclist items returned from handlers, and set up defaults for convenience
2017-02-26 14:51:22 +00:00
`text` - This error message is required.
#1398 document the detail key
2018-06-20 22:10:01 +00:00
`detail` - An optional, more descriptive message.
This message can be displayed with the |ALEDetail|
command instead of the message for `text`, if set.
Copy all loclist items returned from handlers, and set up defaults for convenience
2017-02-26 14:51:22 +00:00
`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
Fix typos
2017-10-02 16:11:54 +00:00
converted to number using `str2nr()`.
#739 - Document the end_col and end_lnum keys for the loclist format
2017-07-15 23:40:20 +00:00
`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.
#653 - Explain the new `filename` key support in the documentation
2017-08-19 23:16:28 +00:00
`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 asssumed
to be the buffer being checked, unless the `bufnr`
key is also set with a valid number for some other
buffer.
Copy all loclist items returned from handlers, and set up defaults for convenience
2017-02-26 14:51:22 +00:00
`vcol` - Defaults to `0`.
Fix #605 - Support `vcol: 1` for multi-byte character positions
2018-04-08 16:17:30 +00:00
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.
Copy all loclist items returned from handlers, and set up defaults for convenience
2017-02-26 14:51:22 +00:00
`type` - Defaults to `'E'`.
`nr` - Defaults to `-1`.
Improved documentation for `code` loclist item field
2018-08-02 16:18:43 +00:00
Numeric error code. If `nr` is not `-1`, `code`
likely should contain the string representation of
Handle LSP codes for `%code%` in message formats fixes #1767
2018-07-30 22:19:59 +00:00
the same value.
Improved documentation for `code` loclist item field
2018-08-02 16:18:43 +00:00
`code` - No default; may be unset.
Handle LSP codes for `%code%` in message formats fixes #1767
2018-07-30 22:19:59 +00:00
Improved documentation for `code` loclist item field
2018-08-02 16:18:43 +00:00
Human-readable |String| error code.
Handle LSP codes for `%code%` in message formats fixes #1767
2018-07-30 22:19:59 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
`executable` A |String| naming the executable itself which
proselint: Add more supported filetypes (#367) * proselint: Add more suported filetypes * proselint: Minor consistency fixes * Vim help: Disable linters by default
2017-03-02 00:06:09 +00:00
will be run. This value will be used to check if the
Add a help file for the project.
2016-10-05 23:22:32 +00:00
program requested is installed or not.
Either this or the `executable_callback` argument
must be provided.
`executable_callback ` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned for the executable to check. This can be
used in place of `executable` when more complicated
processing is needed.
`command` A |String| for an executable to run asynchronously.
This command will be fed the lines from the buffer to
check, and will produce the lines of output given to
the `callback`.
`command_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned for a command to run. This can be used in
place of `command` when more complicated processing
is needed.
Document the command empty string behaviour
2017-02-10 23:11:26 +00:00
If an empty string is returned from the callback,
no jobs for linting will be run for that linter.
This can be used for skipping a linter call,
say if no configuration file was found.
Add some more tags to the documentation, for easy references
2017-04-23 17:06:26 +00:00
*ale-command-chain*
Document the command_chain option
2017-02-09 09:42:17 +00:00
`command_chain` A |List| of |Dictionary| items defining a series
of commands to be run. At least one |Dictionary|
should be provided. Each Dictionary must contain the
key `callback`, defining a |String| or |Funcref| for
a function returning a |String| for a command to run.
The callback functions for each command after the
first command in in the chain should accept two
arguments `(buffer, output)`, a buffer number and a
|List| of lines of output from the previous command
in the chain.
The first callback function in a chain accepts only
a `(buffer)` argument, as there are no previous
commands to run which return `output`.
Document the command empty string behaviour
2017-02-10 23:11:26 +00:00
If an empty string is returned for a command in a
chain, that command in the chain will be skipped,
and the next function in the chain will be called
immediately instead. If the last command in a chain
returns an empty string, then no linting will be
performed.
Document the command_chain option
2017-02-09 09:42:17 +00:00
Commands in the chain will all use the
`output_stream` value provided in the root
|Dictionary|. Each command in the chain can also
provide an `output_stream` key to override this value.
See the `output_stream` description for more
information.
Fix #315 Implement the read_buffer option
2017-02-09 23:32:57 +00:00
Commands in the chain all behave as if `read_buffer`
is set to `0` by default, except for the last command
in the chain, which uses the value set for
`read_buffer` in the root |Dictionary|. Each command
in the chain can also provide a `read_buffer` key
to override these values.
See the `read_buffer` description for more
information.
Document the command_chain option
2017-02-09 09:42:17 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
`output_stream` A |String| for the output stream the lines of output
should be read from for the command which is run. The
Support reading from both output streams, and fix PHP error parsing, which sometimes logs to stderr, sometimes stdout.
2016-10-07 16:08:11 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix #315 Implement the read_buffer option
2017-02-09 23:32:57 +00:00
`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.
Add some more tags to the documentation, for easy references
2017-04-23 17:06:26 +00:00
*ale-lint-file*
#333 Finish implementing the lint_file option
2017-03-21 14:52:02 +00:00
`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
Run before lint cycle, rename autocmds
2017-12-10 13:03:03 +00:00
manually, per |ALELintPost-autocmd|.
#333 Finish implementing the lint_file option
2017-03-21 14:52:02 +00:00
When this option is set to `1`, `read_buffer` will
be set automatically to `0`. The two options cannot
be used together.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
*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
Close #830 - Implement LSP connections via TCP sockets
2018-07-03 00:41:46 +00:00
process for a language server running, and
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
communicates with it directly via a |channel|.
Close #830 - Implement LSP connections via TCP sockets
2018-07-03 00:41:46 +00:00
`executable` or `executable_callback` must be set,
and `command` or `command_callback` 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_callback` must be set
with a callback returning an address to connect to.
ALE will not start a server automatically.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
Make the language option for LSP linters optional
2018-07-04 12:12:58 +00:00
When this argument is not empty
`project_root_callback` must be defined.
`language` or `language_callback` can be defined to
describe the language for a file. The filetype will
be used as the language by default.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
Fix typos
2017-10-02 16:11:54 +00:00
LSP linters handle diagnostics automatically, so
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
the `callback` argument must not be defined.
Fix #1523 - Document completion_filter
2018-05-30 19:44:09 +00:00
An optional `completion_filter` callback may be
defined for filtering completion results.
Allow initialization options to be passed to language servers
2018-06-06 15:58:49 +00:00
An optional `initialization_options` or
`initialization_options_callback` may be defined to
pass initialization options to the LSP.
Close #830 - Implement LSP connections via TCP sockets
2018-07-03 00:41:46 +00:00
`address_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned with an address to connect to.
This argument must only be set if the `lsp` argument
is set to `'socket'`.
Fix a typo in the LSP linter documentation
2018-05-30 19:23:57 +00:00
`project_root_callback` A |String| or |Funcref| for a callback function
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
accepting a buffer number. A |String| should be
returned representing the path to the project for the
file being checked with the language server. 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.
Close #1521 - Allow the language to be set with simple strings for LSP linters
2018-04-27 21:52:11 +00:00
`language` A |String| representing the name of the language
being checked. This string will be sent to the LSP to
tell it what type of language is being checked.
Make the language option for LSP linters optional
2018-07-04 12:12:58 +00:00
If this or `language_callback` isn't set, the
language will default to the value of the filetype
given to |ale#linter#Define|.
Close #1521 - Allow the language to be set with simple strings for LSP linters
2018-04-27 21:52:11 +00:00
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
`language_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned representing the name of the language being
checked.
Close #1521 - Allow the language to be set with simple strings for LSP linters
2018-04-27 21:52:11 +00:00
This option can be used instead of `language` if a
linter can check multiple languages.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
Fix #1523 - Document completion_filter
2018-05-30 19:44:09 +00:00
`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
Fix #500 - Support defining aliases for linter names
2017-05-27 20:27:42 +00:00
`aliases` A |List| of aliases for the linter name.
#517 - Document arguments for defining LSP linters
2017-08-07 12:31:29 +00:00
This argument can be set with alternative names for
selecting the linter with |g:ale_linters|. This
Fix #500 - Support defining aliases for linter names
2017-05-27 20:27:42 +00:00
setting can make it easier to guess the linter name
by offering a few alternatives.
Allow initialization options to be passed to language servers
2018-06-06 15:58:49 +00:00
`initialization_options` A |Dictionary| of initialization options for LSPs.
This will be fed (as JSON) to the LSP in the
initialize command.
`initialization_options_callback`
A |String| or |Funcref| for a callback function
accepting a buffer number. A |Dictionary| should be
returned for initialization options to pass the LSP.
This can be used in place of `initialization_options`
when more complicated processing is needed.
Document the command_chain option
2017-02-09 09:42:17 +00:00
Only one of `command`, `command_callback`, or `command_chain` should be
specified. `command_callback` is generally recommended when a command string
needs to be generated dynamically, or any global options are used.
`command_chain` is recommended where any system calls need to be made to
retrieve some kind of information before running the final command.
Add support for managing temporary files/directories
2017-02-11 15:16:08 +00:00
If temporary files or directories are created for commands run with
`command_callback` or `command_chain`, then these tempoary files or
directories can be managed by ALE, for automatic deletion.
See |ale#engine#ManageFile()| and |ale#engine#ManageDirectory| for more
information.
Add some more tags to the documentation, for easy references
2017-04-23 17:06:26 +00:00
*ale-command-format-strings*
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
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.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
For example: >
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
'command': 'eslint -f unix --stdin --stdin-filename %s'
Add a help file for the project.
2016-10-05 23:22:32 +00:00
<
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
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
proselint: Add more supported filetypes (#367) * proselint: Add more suported filetypes * proselint: Minor consistency fixes * Vim help: Disable linters by default
2017-03-02 00:06:09 +00:00
contents of the buffer being checked. All occurrences of `%t` in command
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
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#engine#ManageDirectory|. This option can be used for some linters which
do not support reading from stdin.
For example: >
'command': 'ghc -fno-code -v0 %t',
Support formatting escaped executable names into commands with %e
2018-07-05 19:56:31 +00:00
<
Any substring `%e` will be replaced with the escaped executable supplied
with `executable` or `executable_callback`. 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',
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
<
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
Support formatting escaped executable names into commands with %e
2018-07-05 19:56:31 +00:00
possibly contain `%%`, `%s`, `%t`, or `%e`, where the special formatting
behavior is not desired, the |ale#engine#EscapeCommandPart()| function can
be used to replace those characters to avoid formatting issues.
Add support for temporary filename substitution, for replacing stdin_wrapper
2017-02-11 18:14:18 +00:00
Add an American English tag for behaviour too
2018-04-24 20:56:34 +00:00
*ale-linter-loading-behavior*
Fix #450 Document how linters are loaded
2017-04-24 21:40:15 +00:00
*ale-linter-loading-behaviour*
Linters for ALE will be loaded by searching |runtimepath| in the following
format: >
ale_linters/<filetype>/<linter_name>.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.
#1278 Allow linters to be defined pretty much anywhere
2018-04-24 20:48:33 +00:00
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}')},
\})
<
Add a help file for the project.
2016-10-05 23:22:32 +00:00
First pass at optimizing ale to autoload (#80) * First pass at optimizing ale to autoload First off, the structure/function names should be revised a bit, but I will wait for @w0rp's input before unifying the naming style. Second off, the docs probably need some more work, I just did some simple find-and-replace work. With that said, this pull brings major performance gains for ale. On my slowest system, fully loading ale and all its code takes around 150ms. I have moved all of ale's autoload-able code to autoload/, and in addition, implemented lazy-loading of linters. This brings load time on that same system down to 5ms. The only downside of lazy loading is that `g:ale_linters` cannot be changed at runtime; however, it also speeds up performance at runtime by simplfying the logic greatly. Please let me know what you think! Closes #59 * Address Travis/Vint errors For some reason, ale isn't running vint for me... * Incorporate feedback, make fixes Lazy-loading logic is much improved. * Add header comments; remove incorrect workaround * Remove unneeded plugin guards * Fix lazy-loading linter logic Set the wrong variable.... * Fix capitialization
2016-10-10 18:51:29 +00:00
ale#linter#Get(filetype) *ale#linter#Get()*
Clean up the documentation some more, and make the description of the ALELint autocmd clearer
2017-03-22 08:57:29 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Return all of linters configured for a given filetype as a |List| of
First pass at optimizing ale to autoload (#80) * First pass at optimizing ale to autoload First off, the structure/function names should be revised a bit, but I will wait for @w0rp's input before unifying the naming style. Second off, the docs probably need some more work, I just did some simple find-and-replace work. With that said, this pull brings major performance gains for ale. On my slowest system, fully loading ale and all its code takes around 150ms. I have moved all of ale's autoload-able code to autoload/, and in addition, implemented lazy-loading of linters. This brings load time on that same system down to 5ms. The only downside of lazy loading is that `g:ale_linters` cannot be changed at runtime; however, it also speeds up performance at runtime by simplfying the logic greatly. Please let me know what you think! Closes #59 * Address Travis/Vint errors For some reason, ale isn't running vint for me... * Incorporate feedback, make fixes Lazy-loading logic is much improved. * Add header comments; remove incorrect workaround * Remove unneeded plugin guards * Fix lazy-loading linter logic Set the wrong variable.... * Fix capitialization
2016-10-10 18:51:29 +00:00
|Dictionary| values in the format specified by |ale#linter#Define()|.
Add a help file for the project.
2016-10-05 23:22:32 +00:00
Fix typos
2017-10-02 16:11:54 +00:00
Filetypes may be dot-separated to invoke linters for multiple filetypes:
Docs!
2016-10-22 13:29:30 +00:00
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
Fix typos
2017-10-02 16:11:54 +00:00
are applied after dot-separated filetypes are broken up into their
Docs!
2016-10-22 13:29:30 +00:00
components.
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
#1278 Allow linters to be defined pretty much anywhere
2018-04-24 20:48:33 +00:00
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.
Mention the Count argument in the documentation
2017-05-25 12:32:46 +00:00
ale#statusline#Count(buffer) *ale#statusline#Count()*
#323 Document ale#statusline#Count() instead, and encourage its use
2017-05-24 09:23:13 +00:00
Mention the Count argument in the documentation
2017-05-25 12:32:46 +00:00
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:
Clean up the documentation some more, and make the description of the ALELint autocmd clearer
2017-03-22 08:57:29 +00:00
#323 Document ale#statusline#Count() instead, and encourage its use
2017-05-24 09:23:13 +00:00
`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.
Update the documentation files ... and move all pictures to img/ directory
2016-10-07 16:48:47 +00:00
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
Close #1379 - Increment b:ale_linted when a buffer is checked
2018-03-03 16:22:56 +00:00
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'
<
Clean up some doc formatting
2017-12-17 12:11:30 +00:00
ALELintPre *ALELintPre-autocmd*
ALELintPost *ALELintPost-autocmd*
Add ALEFixPre and ALEFixPost events To run autocmd before and after every fix cycle. Fixes #623 (`ALELintPre` was added in #1203).
2017-12-23 13:13:55 +00:00
ALEFixPre *ALEFixPre-autocmd*
ALEFixPost *ALEFixPost-autocmd*
Clean up the documentation some more, and make the description of the ALELint autocmd clearer
2017-03-22 08:57:29 +00:00
Add ALEFixPre and ALEFixPost events To run autocmd before and after every fix cycle. Fixes #623 (`ALELintPre` was added in #1203).
2017-12-23 13:13:55 +00:00
These |User| autocommands are triggered before and after every lint or fix
cycle. They can be used to update statuslines, send notifications, etc.
#764 - Update the documentation to mention how to echo messages with the ALELint autocmd
2017-07-13 23:33:03 +00:00
The autocmd commands are run with |:silent|, so |:unsilent| is required for
echoing messges.
Document ALELint autocommand
2016-10-13 13:01:48 +00:00
Run before lint cycle, rename autocmds
2017-12-10 13:03:03 +00:00
For example to change the color of the statusline while the linter is
running:
>
augroup ALEProgress
autocmd!
autocmd User ALELintPre hi Statusline ctermfg=darkgrey
Fix case typo in the documentation
2018-08-23 18:24:47 +00:00
autocmd User ALELintPost hi Statusline ctermfg=NONE
Run before lint cycle, rename autocmds
2017-12-10 13:03:03 +00:00
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
Add ALEJobStarted User autocommand event The ALELintPre and ALELintPost autocommand events are currently being used by lightline-ale to refresh the status line and check the linter status for a current buffer. One of the plugin's checks looks to see if linters are currently running, via ale#engine#IsCheckingBuffer(). This currently only works partially in certain situations. In my particular case, working with Go files, this only seems to function properly when a file is initially opened. Saving a file does not correctly update the status. This seems to be due to the fact that ALELintPre actually runs before any jobs are carried out, making it plausible that hooking into ALELintPre for the purpose of checking to see if there are any currently running linters for a buffer is unreliable as it would be prone to pretty obvious race conditions. This adds a new User autocommand, ALEJobStarted, that gets fired at the start of every new job that is successfully run. This allows a better point to hook into checking the linter status of a buffer using ale#engine#IsCheckingBuffer() by ensuring that at least one job has started by the time IsCheckingBuffer is run.
2018-04-27 22:40:02 +00:00
Run before lint cycle, rename autocmds
2017-12-10 13:03:03 +00:00
<
Add ALEJobStarted User autocommand event The ALELintPre and ALELintPost autocommand events are currently being used by lightline-ale to refresh the status line and check the linter status for a current buffer. One of the plugin's checks looks to see if linters are currently running, via ale#engine#IsCheckingBuffer(). This currently only works partially in certain situations. In my particular case, working with Go files, this only seems to function properly when a file is initially opened. Saving a file does not correctly update the status. This seems to be due to the fact that ALELintPre actually runs before any jobs are carried out, making it plausible that hooking into ALELintPre for the purpose of checking to see if there are any currently running linters for a buffer is unreliable as it would be prone to pretty obvious race conditions. This adds a new User autocommand, ALEJobStarted, that gets fired at the start of every new job that is successfully run. This allows a better point to hook into checking the linter status of a buffer using ale#engine#IsCheckingBuffer() by ensuring that at least one job has started by the time IsCheckingBuffer is run.
2018-04-27 22:40:02 +00:00
ALEJobStarted *ALEJobStarted-autocmd*
This |User| autocommand is triggered immediately after a job is successfully
run. This provides better accuracy for checking linter status with
Fix tests by setting proper link tag in doc for ALEJobStarted
2018-04-28 05:32:21 +00:00
|ale#engine#IsCheckingBuffer()| over |ALELintPre-autocmd|, which is actually
Add ALEJobStarted User autocommand event The ALELintPre and ALELintPost autocommand events are currently being used by lightline-ale to refresh the status line and check the linter status for a current buffer. One of the plugin's checks looks to see if linters are currently running, via ale#engine#IsCheckingBuffer(). This currently only works partially in certain situations. In my particular case, working with Go files, this only seems to function properly when a file is initially opened. Saving a file does not correctly update the status. This seems to be due to the fact that ALELintPre actually runs before any jobs are carried out, making it plausible that hooking into ALELintPre for the purpose of checking to see if there are any currently running linters for a buffer is unreliable as it would be prone to pretty obvious race conditions. This adds a new User autocommand, ALEJobStarted, that gets fired at the start of every new job that is successfully run. This allows a better point to hook into checking the linter status of a buffer using ale#engine#IsCheckingBuffer() by ensuring that at least one job has started by the time IsCheckingBuffer is run.
2018-04-27 22:40:02 +00:00
triggered before any linters are executed.
Clean up some doc formatting
2017-12-17 12:11:30 +00:00
Add the logo and thank Mark for his work.
2016-10-11 20:55:26 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
10. Special Thanks *ale-special-thanks*
Add the logo and thank Mark for his work.
2016-10-11 20:55:26 +00:00
Special thanks to Mark Grealish (https://www.bhalash.com/) for providing ALE's
snazzy looking ale glass logo. Cheers, Mark!
Make spacing and indentation consistent in the documentation, and make the docs easier to read.
2016-10-09 20:20:21 +00:00
Add a help file for the project.
2016-10-05 23:22:32 +00:00
===============================================================================
Fix - #883 Document linting behavior better, sync up the lists of supported tools, andautomatically demand that they stay in sync
2017-08-28 21:05:12 +00:00
11. Contact *ale-contact*
Add a help file for the project.
2016-10-05 23:22:32 +00:00
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.
Move design goals to online documentation
2018-06-28 15:20:30 +00:00
===============================================================================
Add a help file for the project.
2016-10-05 23:22:32 +00:00
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
Reference in New Issue Copy Permalink