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

Fix the clangtidy linter, and document everything

Browse Source
This commit is contained in:
w0rp 2017-02-11 23:45:06 +00:00
parent 355608b031
commit ed269b8831
3 changed files with 55 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -54,7 +54,7 @@ name. That seems to be the fairest way to arrange this table.
| Bash | [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/) | | Bash | [-n flag](https://www.gnu.org/software/bash/manual/bash.html#index-set), [shellcheck](https://www.shellcheck.net/) |
| Bourne Shell | [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/) | | Bourne Shell | [-n flag](http://linux.die.net/man/1/sh), [shellcheck](https://www.shellcheck.net/) |
| C | [cppcheck](http://cppcheck.sourceforge.net), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/)| | C | [cppcheck](http://cppcheck.sourceforge.net), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/)|
| C++ (filetype cpp) | [cppcheck] (http://cppcheck.sourceforge.net), [gcc](https://gcc.gnu.org/), [clang](http://clang.llvm.org/)| | C++ (filetype cpp) | [clang](http://clang.llvm.org/), [clangtidy](http://clang.llvm.org/extra/clang-tidy/), [cppcheck] (http://cppcheck.sourceforge.net), [gcc](https://gcc.gnu.org/)|
| C# | [mcs](http://www.mono-project.com/docs/about-mono/languages/csharp/) | | C# | [mcs](http://www.mono-project.com/docs/about-mono/languages/csharp/) |
| Chef | [foodcritic](http://www.foodcritic.io/) | | Chef | [foodcritic](http://www.foodcritic.io/) |
| CoffeeScript | [coffee](http://coffeescript.org/), [coffeelint](https://www.npmjs.com/package/coffeelint) | | CoffeeScript | [coffee](http://coffeescript.org/), [coffeelint](https://www.npmjs.com/package/coffeelint) |

13
ale_linters/cpp/clangtidy.vim
View File

@ -1,15 +1,18 @@
" Author: vdeurzen <tim@kompiler.org> " Author: vdeurzen <tim@kompiler.org>, w0rp <devw0rp@gmail.com>
" Description: clang-tidy linter for cpp files " Description: clang-tidy linter for cpp files
" Set this option to change the clang-tidy options for warnings for C. " Set this option to change the clang-tidy options for warnings for C.
if !exists('g:ale_cpp_clangtidy_options') let g:ale_cpp_clangtidy_options =
let g:ale_cpp_clangtidy_options = '-std=c++14 -Wall' \ get(g:, 'ale_cpp_clangtidy_options', '-std=c++14 -Wall')
endif
function! ale_linters#cpp#clangtidy#GetCommand(buffer) abort
return 'clang-tidy %t -- ' . g:ale_cpp_clangtidy_options
endfunction
call ale#linter#Define('cpp', { call ale#linter#Define('cpp', {
\ 'name': 'clangtidy', \ 'name': 'clangtidy',
\ 'output_stream': 'stdout', \ 'output_stream': 'stdout',
\ 'executable': 'clang-tidy', \ 'executable': 'clang-tidy',
\ 'command': g:ale#util#stdin_wrapper . ' -- ' . g:ale_cpp_clangtidy_options, \ 'command_callback': 'ale_linters#cpp#clangtidy#GetCommand',
\ 'callback': 'ale#handlers#HandleGCCFormat', \ 'callback': 'ale#handlers#HandleGCCFormat',
\}) \})

81
doc/ale.txt
View File

@ -27,18 +27,19 @@ CONTENTS *ale-contents*
4.15. htmlhint........................|ale-linter-options-htmlhint| 4.15. htmlhint........................|ale-linter-options-htmlhint|
4.16. c-clang.........................|ale-linter-options-c-clang| 4.16. c-clang.........................|ale-linter-options-c-clang|
4.17. cpp-clang.......................|ale-linter-options-cpp-clang| 4.17. cpp-clang.......................|ale-linter-options-cpp-clang|
4.18. python-flake8...................|ale-linter-options-python-flake8| 4.18. cpp-clangtidy...................|ale-linter-options-cpp-clangtidy|
4.19. ruby-rubocop....................|ale-linter-options-ruby-rubocop| 4.19. python-flake8...................|ale-linter-options-python-flake8|
4.20. chktex..........................|ale-linter-options-chktex| 4.20. ruby-rubocop....................|ale-linter-options-ruby-rubocop|
4.21. lacheck.........................|ale-linter-options-lacheck| 4.21. chktex..........................|ale-linter-options-chktex|
4.22. stylelint.......................|ale-linter-options-stylelint| 4.22. lacheck.........................|ale-linter-options-lacheck|
4.23. rustc...........................|ale-linter-options-rustc| 4.23. stylelint.......................|ale-linter-options-stylelint|
4.24. python-mypy.....................|ale-linter-options-python-mypy| 4.24. rustc...........................|ale-linter-options-rustc|
4.25. python-pylint...................|ale-linter-options-python-pylint| 4.25. python-mypy.....................|ale-linter-options-python-mypy|
4.26. erlang..........................|ale-linter-options-erlang| 4.26. python-pylint...................|ale-linter-options-python-pylint|
4.27. phpmd...........................|ale-linter-options-phpmd| 4.27. erlang..........................|ale-linter-options-erlang|
4.28. xo..............................|ale-linter-options-xo| 4.28. phpmd...........................|ale-linter-options-phpmd|
4.28. javac...........................|ale-linter-options-javac| 4.29. xo..............................|ale-linter-options-xo|
4.30. javac...........................|ale-linter-options-javac|
5. Linter Integration Notes.............|ale-linter-integration| 5. Linter Integration Notes.............|ale-linter-integration|
5.1. merlin..........................|ale-linter-integration-ocaml-merlin| 5.1. merlin..........................|ale-linter-integration-ocaml-merlin|
5.2. rust.............................|ale-integration-rust| 5.2. rust.............................|ale-integration-rust|
@ -74,7 +75,7 @@ The following languages and tools are supported.
* Bash: 'shell' (-n flag), 'shellcheck' * Bash: 'shell' (-n flag), 'shellcheck'
* Bourne Shell: 'shell' (-n flag), 'shellcheck' * Bourne Shell: 'shell' (-n flag), 'shellcheck'
* C: 'cppcheck', 'gcc', 'clang' * C: 'cppcheck', 'gcc', 'clang'
* C++ (filetype cpp): 'cppcheck', 'gcc', 'clang' * C++ (filetype cpp): 'clang', 'clangtidy', 'cppcheck', 'gcc'
* C#: 'mcs' * C#: 'mcs'
* Chef: 'foodcritic' * Chef: 'foodcritic'
* CoffeeScript: 'coffee', 'coffelint' * CoffeeScript: 'coffee', 'coffelint'
@ -651,7 +652,7 @@ g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
This variable can be changed to modify flags given to HTMLHint. This variable can be changed to modify flags given to HTMLHint.
g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable* g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable*
Type: |String| Type: |String|
Default: `'htmlhint'` Default: `'htmlhint'`
@ -663,7 +664,7 @@ g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable
|g:ale_html_htmlhint_use_global| to `1`. |g:ale_html_htmlhint_use_global| to `1`.
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global* g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
Type: |String| Type: |String|
Default: `0` Default: `0`
@ -691,10 +692,20 @@ g:ale_cpp_clang_options *g:ale_cpp_clang_options*
Type: |String| Type: |String|
Default: `'-std=c11 -Wall'` Default: `'-std=c11 -Wall'`
This variable can be change to modify flags given to clang. This variable can be changed to modify flags given to clang.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.18. python-flake8 *ale-linter-options-python-flake8* 4.18. cpp-clangtidy *ale-linter-options-cpp-clangtidy*
g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
Type: |String|
Default: `'-std=c++14 -Wall'`
This variable can be changed to modify flags given to clangtidy.
-------------------------------------------------------------------------------
4.19. python-flake8 *ale-linter-options-python-flake8*
g:ale_python_flake8_executable *g:ale_python_flake8_executable* g:ale_python_flake8_executable *g:ale_python_flake8_executable*
@ -722,7 +733,7 @@ g:ale_python_flake8_args *g:ale_python_flake8_args*
`python3 -m pip install --user flake8`). `python3 -m pip install --user flake8`).
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.19. ruby-rubocop *ale-linter-options-ruby-rubocop* 4.20. ruby-rubocop *ale-linter-options-ruby-rubocop*
g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options* g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
@ -732,7 +743,7 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
This variable can be change to modify flags given to rubocop. This variable can be change to modify flags given to rubocop.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.20. chktex *ale-linter-options-chktex* 4.21. chktex *ale-linter-options-chktex*
g:ale_tex_chktex_executable *g:ale_tex_chktex_executable* g:ale_tex_chktex_executable *g:ale_tex_chktex_executable*
@ -750,9 +761,9 @@ g:ale_tex_chktex_options *g:ale_tex_chktex_options*
This variable can be changed to modify flags given to chktex. This variable can be changed to modify flags given to chktex.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.21. lacheck *ale-linter-options-lacheck* 4.22. lacheck *ale-linter-options-lacheck*
g:ale_lacheck_executable *g:ale_lacheck_executable* g:ale_lacheck_executable *g:ale_lacheck_executable*
Type: |String| Type: |String|
Default: '`lacheck`' Default: '`lacheck`'
@ -760,9 +771,9 @@ g:ale_lacheck_executable *g:ale_lacheck_executable*
This variable can be changed to change the path to lacheck. This variable can be changed to change the path to lacheck.
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.22. stylelint *ale-linter-options-stylelint* 4.23. stylelint *ale-linter-options-stylelint*
g:ale_css_stylelint_executable *g:ale_css_stylelint_executable* g:ale_css_stylelint_executable *g:ale_css_stylelint_executable*
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
@ -774,7 +785,7 @@ g:ale_css_stylelint_executable *g:ale_css_stylelint_executable
|g:ale_css_stylelint_use_global| to `1`. |g:ale_css_stylelint_use_global| to `1`.
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global* g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
Type: |String| Type: |String|
Default: `0` Default: `0`
@ -785,7 +796,7 @@ g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global
stylelint in node_modules. stylelint in node_modules.
g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable* g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable*
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
@ -797,7 +808,7 @@ g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable
|g:ale_sass_stylelint_use_global| to `1`. |g:ale_sass_stylelint_use_global| to `1`.
g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global* g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global*
Type: |String| Type: |String|
Default: `0` Default: `0`
@ -808,7 +819,7 @@ g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global
stylelint in node_modules. stylelint in node_modules.
g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable* g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable*
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
@ -820,7 +831,7 @@ g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable
|g:ale_scss_stylelint_use_global| to `1`. |g:ale_scss_stylelint_use_global| to `1`.
g:ale_scss_stylelint_use_global *g:ale_scss_stylelint_use_global* g:ale_scss_stylelint_use_global *g:ale_scss_stylelint_use_global*
Type: |String| Type: |String|
Default: `0` Default: `0`
@ -831,7 +842,7 @@ g:ale_scss_stylelint_use_global *g:ale_scss_stylelint_use_global
stylelint in node_modules. stylelint in node_modules.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.23. rustc *ale-linter-options-rustc* 4.24. rustc *ale-linter-options-rustc*
g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes* g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
@ -845,7 +856,7 @@ g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.24. python-mypy *ale-linter-options-python-mypy* 4.25. python-mypy *ale-linter-options-python-mypy*
g:ale_python_mypy_options *g:ale_python_mypy_options* g:ale_python_mypy_options *g:ale_python_mypy_options*
@ -857,7 +868,7 @@ g:ale_python_mypy_options *g:ale_python_mypy_options*
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
4.25. python-pylint *ale-linter-options-python-pylint* 4.26. python-pylint *ale-linter-options-python-pylint*
g:ale_python_pylint_executable *g:ale_python_pylint_executable* g:ale_python_pylint_executable *g:ale_python_pylint_executable*
@ -885,7 +896,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options*
`python3 -m pip install --user pylint`). `python3 -m pip install --user pylint`).
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.26. erlang *ale-linter-options-erlang* 4.27. erlang *ale-linter-options-erlang*
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options* g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
@ -896,7 +907,7 @@ g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
or `-pa`. or `-pa`.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.27. phpmd *ale-linter-options-phpmd* 4.28. phpmd *ale-linter-options-phpmd*
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset* g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
@ -907,7 +918,7 @@ g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
the available phpmd rulesets the available phpmd rulesets
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.28. xo *ale-linter-options-xo* 4.29. xo *ale-linter-options-xo*
g:ale_javascript_xo_executable *g:ale_javascript_xo_executable* g:ale_javascript_xo_executable *g:ale_javascript_xo_executable*
@ -942,7 +953,7 @@ g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
xo in node_modules. xo in node_modules.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.28. javac *ale-linter-options-javac* 4.30. javac *ale-linter-options-javac*
g:ale_java_javac_classpath *g:ale_java_javac_classpath* g:ale_java_javac_classpath *g:ale_java_javac_classpath*