diff --git a/README.md b/README.md index bfca067..1e41409 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/ale_linters/lua/luacheck.vim b/ale_linters/lua/luacheck.vim new file mode 100644 index 0000000..11638ad --- /dev/null +++ b/ale_linters/lua/luacheck.vim @@ -0,0 +1,48 @@ +" Author: Sol Bekic https://github.com/s-ol +" Description: luacheck linter for lua files + +if exists('g:loaded_ale_linters_lua_luacheck') + finish +endif + +let g:loaded_ale_linters_lua_luacheck = 1 + +let g:ale_lua_luacheck_executable = +\ get(g:, 'ale_lua_luacheck_executable', 'luacheck') + +function! ale_linters#lua#luacheck#Handle(buffer, lines) + " Matches patterns line the following: + " + " artal.lua:159:17: (W111) shadowing definition of loop variable 'i' on line 106 + " artal.lua:182:7: (W213) unused loop variable 'i' + let l:pattern = '^.*:\(\d\+\):\(\d\+\): (\([WE]\)\d\+) \(.\+\)$' + let l:output = [] + + for l:line in a:lines + let l:match = matchlist(l:line, l:pattern) + + if len(l:match) == 0 + continue + endif + + " vcol is Needed to indicate that the column is a character. + call add(l:output, { + \ 'bufnr': a:buffer, + \ 'lnum': l:match[1] + 0, + \ 'vcol': 0, + \ 'col': l:match[2] + 0, + \ 'text': l:match[4], + \ 'type': l:match[3], + \ 'nr': -1, + \}) + endfor + + return l:output +endfunction + +call ale#linter#Define('lua', { +\ 'name': 'luacheck', +\ 'executable': g:ale_lua_luacheck_executable, +\ 'command': g:ale_lua_luacheck_executable . ' --formatter plain --codes --filename %s -', +\ 'callback': 'ale_linters#lua#luacheck#Handle', +\}) diff --git a/doc/ale.txt b/doc/ale.txt index 2f4349e..92920ba 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*