summaryrefslogtreecommitdiff
path: root/doc/ale.txt
diff options
context:
space:
mode:
authorpetpetpetpet <34608655+petpetpetpet@users.noreply.github.com>2019-01-27 12:44:49 +0000
committerw0rp <w0rp@users.noreply.github.com>2019-01-27 12:44:49 +0000
commit3c38fdb1bb3625bcb222cfce16acd7db360ef413 (patch)
treea3953cca25d568a0cf4f39091a75b187812c47e6 /doc/ale.txt
parenta7b3b84899ba8752b4db91aff3b9a1b7a7a6fd83 (diff)
downloadale-3c38fdb1bb3625bcb222cfce16acd7db360ef413.zip
Extend statusline interface (#2240)
* Extended statusline.vim to provide an efficient way to access the first errors,warnings,stylerrors,stylewarnings,etc from the loclist. * Added documentation and help for the new API function.
Diffstat (limited to 'doc/ale.txt')
-rw-r--r--doc/ale.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 836ee29f..2dc4cddc 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3159,6 +3159,21 @@ ale#statusline#Count(buffer) *ale#statusline#Count()*
`total` -> The total number of problems.
+ale#statusline#FirstProblem(buffer, type) *ale#statusline#FirstProblem()*
+
+ Returns a copy of the first entry in the `loclist` that matches the supplied
+ buffer number and problem type. If there is no such enty, an empty dictionary
+ is returned.
+ Problem type should be one of the strings listed below:
+
+ `error` -> Returns the first `loclist` item with type `E` and
+ `sub_type != 'style'`
+ `warning` -> First item with type `W` and `sub_type != 'style'`
+ `info` -> First item with type `I`
+ `style_error` -> First item with type `E` and `sub_type == 'style'`
+ `style_warning` -> First item with type `W` and `sub_type == 'style'`
+
+
b:ale_linted *b:ale_linted*
`b:ale_linted` is set to the number of times a buffer has been checked by