summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-02-05 15:34:35 +0000
committerw0rp <devw0rp@gmail.com>2017-02-05 15:34:35 +0000
commit9a5fc6f932274cf67587c712973dba5f38cfd276 (patch)
tree14f7dd3ce51c49982bd14e34e3644eac71f98491
parentd953c68ebbbb2cd28c2985394ccf16af903bb78d (diff)
downloadale-9a5fc6f932274cf67587c712973dba5f38cfd276.zip
Make a note in the FAQ about how to use quickfix errors
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1b59b632..8a86f462 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@ In other words, this plugin allows you to lint while you type.
6. [How can I execute some code when ALE stops linting?](#faq-autocmd)
7. [How can I navigate between errors quickly?](#faq-navigation)
8. [How can I run linters only when I save files?](#faq-lint-on-save)
+ 9. [How can I use the quickfix list instead of the loclist?](#faq-quickfix)
<a name="supported-languages"></a>
@@ -348,3 +349,30 @@ let g:ale_lint_on_text_changed = 0
" if you don't want linters to run on opening a file
let g:ale_lint_on_enter = 0
```
+
+<a name="faq-quickfix"></a>
+
+### 4.ix. How can I use the quickfix list instead of the loclist?
+
+The quickfix list can be enabled by turning the `g:ale_set_quickfix`
+option on. If you wish to also disable the loclist, you can disable
+the `g:ale_set_loclist` option.
+
+```vim
+" Write this in your vimrc file
+let g:ale_set_loclist = 0
+let g:ale_set_quickfix = 1
+```
+
+If you wish to show Vim windows for the loclist or quickfix items
+when a file contains warnings or errors, `g:ale_open_list` can be
+set to `1`. `g:ale_keep_list_window_open` can be set to `1`
+if you wish to keep the window open even after errors disappear.
+
+```vim
+let g:ale_open_list = 1
+" Set this if you want to.
+" This can be useful if you are combining ALE with
+" some other plugin which sets quickfix errors, etc.
+let g:ale_keep_list_window_open = 1
+```