hasufell/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Create a Contributing section in the README

Browse Source
This commit is contained in:
w0rp 2017-02-23 22:51:08 +00:00
parent c2c6c9f491
commit f48f306ab9
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -23,7 +23,8 @@ In other words, this plugin allows you to lint while you type.
1. [Installation with Pathogen](#installation-with-pathogen) 1. [Installation with Pathogen](#installation-with-pathogen)
2. [Installation with Vundle](#installation-with-vundle) 2. [Installation with Vundle](#installation-with-vundle)
3. [Manual Installation](#manual-installation) 3. [Manual Installation](#manual-installation)
4. [FAQ](#faq) 4. [Contributing](#contributing)
5. [FAQ](#faq)
1. [How do I disable particular linters?](#faq-disable-linters) 1. [How do I disable particular linters?](#faq-disable-linters)
2. [How can I keep the sign gutter open?](#faq-disable-linters) 2. [How can I keep the sign gutter open?](#faq-disable-linters)
3. [How can I change the signs ALE uses?](#faq-change-signs) 3. [How can I change the signs ALE uses?](#faq-change-signs)
@ -99,12 +100,6 @@ name. That seems to be the fairest way to arrange this table.
* *^^ No text linters are enabled by default.* * *^^ No text linters are enabled by default.*
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).
If your tool can read from stdin or you have code to suggest which is good,
support can be happily added for it.
<a name="usage"></a> <a name="usage"></a>
## 2. Usage ## 2. Usage
@ -193,13 +188,27 @@ silent! helptags ALL
Because the author of this plugin is a weird nerd, this is his preferred Because the author of this plugin is a weird nerd, this is his preferred
installation method. installation method.
<a name="contributing"></a>
## 4. Contributing
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).
If your tool can read from stdin or you have code to suggest which is good,
support can be happily added for it.
If you are interested in the general direction of the project, check out the
[wiki home page](https://github.com/w0rp/ale/wiki). The wiki includes a
Roadmap for the future, and more.
<a name="faq"></a> <a name="faq"></a>
## 4. FAQ ## 5. FAQ
<a name="faq-disable-linters"></a> <a name="faq-disable-linters"></a>
### 4.i. How do I disable particular linters? ### 5.i. How do I disable particular linters?
By default, all available tools for all supported languages will be run. By default, all available tools for all supported languages will be run.
If you want to only select a subset of the tools, simply create a If you want to only select a subset of the tools, simply create a
@ -223,7 +232,7 @@ in each directory corresponds to the name of a particular linter.
<a name="faq-keep-signs"></a> <a name="faq-keep-signs"></a>
### 4.ii. How can I keep the sign gutter open? ### 5.ii. How can I keep the sign gutter open?
You can keep the sign gutter open at all times by setting the You can keep the sign gutter open at all times by setting the
`g:ale_sign_column_always` to 1 `g:ale_sign_column_always` to 1
@ -234,7 +243,7 @@ let g:ale_sign_column_always = 1
<a name="faq-change-signs"></a> <a name="faq-change-signs"></a>
### 4.iii. How can I change the signs ALE uses? ### 5.iii. How can I change the signs ALE uses?
Use these options to specify what text should be used for signs: Use these options to specify what text should be used for signs:
@ -254,7 +263,7 @@ highlight clear ALEWarningSign
<a name="faq-statusline"></a> <a name="faq-statusline"></a>
### 4.iv. How can I show errors or warnings in my statusline? ### 5.iv. How can I show errors or warnings in my statusline?
You can use `ALEGetStatusLine()` to integrate ALE into vim statusline. You can use `ALEGetStatusLine()` to integrate ALE into vim statusline.
To enable it, you should have in your `statusline` settings To enable it, you should have in your `statusline` settings
@ -281,7 +290,7 @@ let g:ale_statusline_format = ['⨉ %d', '⚠ %d', '⬥ ok']
<a name="faq-echo-format"></a> <a name="faq-echo-format"></a>
### 4.v. How can I change the format for echo messages? ### 5.v. How can I change the format for echo messages?
There are 3 global options that allow customizing the echoed message. There are 3 global options that allow customizing the echoed message.
@ -306,7 +315,7 @@ Will give you:
<a name="faq-autocmd"></a> <a name="faq-autocmd"></a>
### 4.vi. How can I execute some code when ALE stops linting? ### 5.vi. How can I execute some code when ALE stops linting?
ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html) ALE runs its own [autocmd](http://vimdoc.sourceforge.net/htmldoc/autocmd.html)
event whenever has a linter has been successfully executed and processed. This event whenever has a linter has been successfully executed and processed. This
@ -321,7 +330,7 @@ augroup END
<a name="faq-navigation"></a> <a name="faq-navigation"></a>
### 4.vii. How can I navigate between errors quickly? ### 5.vii. How can I navigate between errors quickly?
ALE offers some commands with `<Plug>` keybinds for moving between warnings and ALE offers some commands with `<Plug>` keybinds for moving between warnings and
errors quickly. You can map the keys Ctrl+j and Ctrl+k to moving between errors errors quickly. You can map the keys Ctrl+j and Ctrl+k to moving between errors
@ -337,7 +346,7 @@ For more information, consult the online documentation with
<a name="faq-lint-on-save"></a> <a name="faq-lint-on-save"></a>
### 4.viii. How can I run linters only when I save files? ### 5.viii. How can I run linters only when I save files?
ALE offers an option `g:ale_lint_on_save` for enabling running the linters ALE offers an option `g:ale_lint_on_save` for enabling running the linters
when files are saved. If you wish to run linters when files are saved, not when files are saved. If you wish to run linters when files are saved, not
@ -355,7 +364,7 @@ let g:ale_lint_on_enter = 0
<a name="faq-quickfix"></a> <a name="faq-quickfix"></a>
### 4.ix. How can I use the quickfix list instead of the loclist? ### 5.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` 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 option on. If you wish to also disable the loclist, you can disable
@ -382,7 +391,7 @@ let g:ale_keep_list_window_open = 1
<a name="faq-jsx-stylelint-eslint"></a> <a name="faq-jsx-stylelint-eslint"></a>
### 4.x. How can I check JSX files with both stylelint and eslint? ### 5.x. How can I check JSX files with both stylelint and eslint?
If you configure ALE options correctly in your vimrc file, and install If you configure ALE options correctly in your vimrc file, and install
the right tools, you can check JSX files with stylelint and eslint. the right tools, you can check JSX files with stylelint and eslint.
@ -415,7 +424,7 @@ no linter will be run twice for the same file.
<a name="faq-my-battery-is-sad"></a> <a name="faq-my-battery-is-sad"></a>
### 4.xi. Will this plugin eat all of my laptop battery power? ### 5.xi. Will this plugin eat all of my laptop battery power?
ALE takes advantage of the power of various tools to check your code. This of ALE takes advantage of the power of various tools to check your code. This of
course means that CPU time will be used to continuously check your code. If you course means that CPU time will be used to continuously check your code. If you