Update the documentation files
... and move all pictures to img/ directory
This commit is contained in:
parent
f128f7810d
commit
c3ae8305b7
5 changed files with 44 additions and 2 deletions
28
README.md
28
README.md
|
@ -3,7 +3,7 @@
|
||||||
ALE (Asynchronous Lint Engine) is a plugin for providing linting in NeoVim
|
ALE (Asynchronous Lint Engine) is a plugin for providing linting in NeoVim
|
||||||
and Vim 8 while you edit your text files.
|
and Vim 8 while you edit your text files.
|
||||||
|
|
||||||
![linting example](example.gif?raw=true)
|
![linting example](img/example.gif?raw=true)
|
||||||
|
|
||||||
ALE makes use of NeoVim and Vim 8 job control functions and timers to
|
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
|
run linters on the contents of text buffers and return errors as
|
||||||
|
@ -83,6 +83,7 @@ vimrc file for all given linters is as follows:
|
||||||
| `g:ale_sign_offset` | an offset for sign ids | `1000000` |
|
| `g:ale_sign_offset` | an offset for sign ids | `1000000` |
|
||||||
| `g:ale_echo_cursor` | echo errors when the cursor is over them | `1` |
|
| `g:ale_echo_cursor` | echo errors when the cursor is over them | `1` |
|
||||||
| `g:ale_warn_about_trailing_whitespace` | enable trailing whitespace warnings for some linters | `1` |
|
| `g:ale_warn_about_trailing_whitespace` | enable trailing whitespace warnings for some linters | `1` |
|
||||||
|
| `g:ale_statusline_format` | String format to use in statusline flag | `['%d error(s)', '%d warning(s)', 'OK']` |
|
||||||
|
|
||||||
### Selecting Particular Linters
|
### Selecting Particular Linters
|
||||||
|
|
||||||
|
@ -123,6 +124,31 @@ let g:ale_sign_error = '>>'
|
||||||
let g:ale_sign_warning = '--'
|
let g:ale_sign_warning = '--'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Statusline
|
||||||
|
|
||||||
|
You can use `ALEGetStatusLine()` to integrate ALE into vim statusline.
|
||||||
|
To enable it, you should have in your `statusline` settings
|
||||||
|
|
||||||
|
```vim
|
||||||
|
%{ALEGetStatusLine()}
|
||||||
|
```
|
||||||
|
|
||||||
|
When errors are detected a string showing the number of errors will be shown.
|
||||||
|
You can customize the output format using the global list `g:ale_statusline_format` where:
|
||||||
|
|
||||||
|
- The 1st element is for errors
|
||||||
|
- The 2nd element is for warnings
|
||||||
|
- The 3rd element is for when no erros are detected
|
||||||
|
|
||||||
|
e.g
|
||||||
|
|
||||||
|
```vim
|
||||||
|
let g:ale_statusline_format = ['⨉ %d', '⚠ %d', '⬥ ok']
|
||||||
|
```
|
||||||
|
|
||||||
|
![Statusline with issues](img/issues.png)
|
||||||
|
![Statusline with no issues](img/no_issues.png)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
To install this plugin, you should use one of the following methods.
|
To install this plugin, you should use one of the following methods.
|
||||||
|
|
18
doc/ale.txt
18
doc/ale.txt
|
@ -1,4 +1,4 @@
|
||||||
*ale.txt* For Vim version 8.0. Last change: 2016 October 5
|
*ale.txt* For Vim version 8.0. Last change: 2016 October 7
|
||||||
*ale*
|
*ale*
|
||||||
|
|
||||||
ALE - Asychronous Lint Engine
|
ALE - Asychronous Lint Engine
|
||||||
|
@ -219,6 +219,16 @@ you can disable these warnings for some linters by setting this option to `0`.
|
||||||
Not all linters may respect this option. If a linter does not, please
|
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.
|
file a bug report, and it may be possible to add such support.
|
||||||
|
|
||||||
|
g:ale_statusline_format *g:ale_statusline_format*
|
||||||
|
|
||||||
|
Type: |List|
|
||||||
|
Default: `['%d error(s)', '%d warning(s)', 'OK']`
|
||||||
|
|
||||||
|
This variable defines the format of |`ALEGetStatusLine()`| output.
|
||||||
|
- The 1st element is for errors
|
||||||
|
- The 2nd element is for warnings
|
||||||
|
- The 3rd element is for when no erros are detected
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
4. Linter Specific Options *ale-linter-options*
|
4. Linter Specific Options *ale-linter-options*
|
||||||
|
|
||||||
|
@ -319,6 +329,12 @@ ALEGetLinters(filetype) *ALEGetLinters()*
|
||||||
Return all of linters configured for a given filetype as a |List| of
|
Return all of linters configured for a given filetype as a |List| of
|
||||||
|Dictionary| values in the format specified by |ALEAddLinter()|.
|
|Dictionary| values in the format specified by |ALEAddLinter()|.
|
||||||
|
|
||||||
|
ALEGetStatusLine() *ALEGetStatusLine()*
|
||||||
|
Return a formatted string that can be added to the statusline.
|
||||||
|
The output's format is defined in |`g:ale_statusline_format`|.
|
||||||
|
To enable it, the following should be present in your |statusline| settings: >
|
||||||
|
%{ALEGetStatusLine()}
|
||||||
|
|
||||||
g:ale#util#stdin_wrapper *g:ale#util#stdin_wrapper*
|
g:ale#util#stdin_wrapper *g:ale#util#stdin_wrapper*
|
||||||
This variable names a wrapper script for sending stdin input to programs
|
This variable names a wrapper script for sending stdin input to programs
|
||||||
which cannot accept input via stdin. See |ALEAddLinter| for more.
|
which cannot accept input via stdin. See |ALEAddLinter| for more.
|
||||||
|
|
Before Width: | Height: | Size: 3.3 MiB After Width: | Height: | Size: 3.3 MiB |
BIN
img/issues.png
Normal file
BIN
img/issues.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 1,008 B |
BIN
img/no_issues.png
Normal file
BIN
img/no_issues.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 956 B |
Reference in a new issue