Merge pull request #58 from KabbAmine/statusline

Add an initial getStatuslineStr function with customizable output

1 files changed, 17 insertions, 1 deletions

diff --git a/doc/ale.txt b/doc/ale.txt
index 3788c2ae..402780b2 100644
--- a/doc/ale.txt
+++ b/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 - Asychronous Lint Engine
@@ -222,6 +222,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
 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*
 
@@ -346,6 +356,12 @@ ALEGetLinters(filetype)                                       *ALEGetLinters()*
   Return all of linters configured for a given filetype as a |List| of
   |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*
   This variable names a wrapper script for sending stdin input to programs
   which cannot accept input via stdin. See |ALEAddLinter| for more.