From c197928d6709aeeb9527a17aeb84f348e8387cd7 Mon Sep 17 00:00:00 2001 From: s-ol Date: Wed, 12 Oct 2016 16:44:53 +0200 Subject: [PATCH] add documentation for luacheck linter --- README.md | 1 + doc/ale.txt | 13 +++++++++++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index bfca0677..1e414095 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ name. That seems to be the fairest way to arrange this table. | HTML | [HTMLHint](http://htmlhint.com/), [tidy](http://www.html-tidy.org/) | | JavaScript | [eslint](http://eslint.org/), [jscs](http://jscs.info/), [jshint](http://jshint.com/) | | JSON | [jsonlint](http://zaa.ch/jsonlint/) | +| Lua | [luacheck](https://github.com/mpeterv/luacheck) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | PHP | [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | diff --git a/doc/ale.txt b/doc/ale.txt index 2f4349e5..92920ba4 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -20,6 +20,7 @@ CONTENTS *ale-contents* 4.8. shell.................................|ale-linter-options-shell| 4.9. shellcheck............................|ale-linter-options-shellcheck| 4.10. vint..................................|ale-linter-options-vint| + 4.11. luacheck..............................|ale-linter-options-luacheck| 5. API........................................|ale-api| 6. Special Thanks.............................|ale-special-thanks| 7. Contact....................................|ale-contact| @@ -61,6 +62,7 @@ The following languages and tools are supported. * HTML: 'HTMLHint', 'tidy' * JavaScript: 'eslint', 'jscs', 'jshint' * JSON: 'jsonlint' +* Lua: 'luacheck' * Perl: 'perl' (-c flag), 'perlcritic' * PHP: 'php' (-l flag), 'phpcs' * Pug: 'pug-lint' @@ -501,6 +503,17 @@ g:ale_vim_vint_show_style_issues *g:ale_vim_vint_show_style_issues* will be reported. +------------------------------------------------------------------------------- +4.11. luacheck *ale-linter-options-luacheck* + +g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable* + + Type: |String| + Default: `'luacheck'` + + This variable can be changed to change the path to luacheck. + + =============================================================================== 5. API *ale-api*