ale/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

# ALE - Asynchronous Lint Engine
ALE (Asynchronous Lint Engine) is a plugin for providing linting in NeoVim
and Vim 8 while you edit your text files.
ALE makes use of NeoVim and Vim 8 job control functions and timers to
run linters on the contents of text buffers and return errors as
text is changed in Vim. This allows for displaying warnings and
2016-09-13 22:18:52 +00:00
errors in files being edited in Vim before files have been saved
back to a filesystem.
In other words, this plugin allows you to lint while you type.
**NOTE:** This Vim plugin has been written pretty quickly so far,
and is still in rapid development. Documentation and stable APIs will
follow later.
## Supported Languages and Tools
<!--
Keep the table rows sorted alphabetically by the language name,
and the tools in the tools column sorted alphabetically by the tool
name. That seems to be the fairest way to arrange this table.
-->
| Language | Tools |
| -------- | ----- |
| Bash | [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set) |
| Bourne Shell | [-n flag](http://linux.die.net/man/1/sh) |
2016-09-16 00:46:49 +00:00
| JavaScript | [eslint](http://eslint.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/) |
2016-09-13 22:17:01 +00:00
| Python | [flake8](http://flake8.pycqa.org/en/latest/) |
2016-09-15 07:42:13 +00:00
| Ruby | [rubocop](https://github.com/bbatsov/rubocop) |
If you would like to see support for more languages and tools, please
[create an issue](https://github.com/w0rp/ale/issues)
or [create a pull request](https://github.com/w0rp/ale/pulls).
2016-09-13 22:12:49 +00:00
If your tool can read from stdin or you have code to suggest which is good,
support can be happily added for more tools.