Add support for linting git commit message files (#1233)

This commit is contained in:
Nick Diego Yamane 2017-12-20 06:10:07 -04:00 committed by w0rp
parent 1568bf8128
commit d4b43d23f4
10 changed files with 218 additions and 0 deletions

View File

@ -100,6 +100,7 @@ formatting.
| Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) | | Erlang | [erlc](http://erlang.org/doc/man/erlc.html), [SyntaxErl](https://github.com/ten0s/syntaxerl) |
| Fortran | [gcc](https://gcc.gnu.org/) | | Fortran | [gcc](https://gcc.gnu.org/) |
| FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) | | FusionScript | [fusion-lint](https://github.com/RyanSquared/fusionscript) |
| Git Commit Messages | [gitlint](https://github.com/jorisroovers/gitlint) |
| GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) | | GLSL | [glslang](https://github.com/KhronosGroup/glslang), [glslls](https://github.com/svenstaro/glsl-language-server) |
| Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! | | Go | [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports), [go vet](https://golang.org/cmd/vet/), [golint](https://godoc.org/github.com/golang/lint), [gometalinter](https://github.com/alecthomas/gometalinter) !!, [go build](https://golang.org/cmd/go/) !!, [gosimple](https://github.com/dominikh/go-tools/tree/master/cmd/gosimple) !!, [staticcheck](https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck) !! |
| GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) | | GraphQL | [eslint](http://eslint.org/), [gqlint](https://github.com/happylinks/gqlint) |

View File

@ -0,0 +1,51 @@
" Author: Nick Yamane <nick.diego@gmail.com>
" Description: gitlint for git commit message files
let g:ale_gitcommit_gitlint_executable =
\ get(g:, 'ale_gitcommit_gitlint_executable', 'gitlint')
let g:ale_gitcommit_gitlint_options = get(g:, 'ale_gitcommit_gitlint_options', '')
let g:ale_gitcommit_gitlint_use_global = get(g:, 'ale_gitcommit_gitlint_use_global', 0)
function! ale_linters#gitcommit#gitlint#GetExecutable(buffer) abort
return ale#python#FindExecutable(a:buffer, 'gitcommit_gitlint', ['gitlint'])
endfunction
function! ale_linters#gitcommit#gitlint#GetCommand(buffer) abort
let l:options = ale#Var(a:buffer, 'gitcommit_gitlint_options')
let l:executable = ale_linters#gitcommit#gitlint#GetExecutable(a:buffer)
return ale#Escape(l:executable)
\ . (!empty(l:options) ? ' ' . l:options : '')
\ . ' lint'
endfunction
function! ale_linters#gitcommit#gitlint#Handle(buffer, lines) abort
" Matches patterns line the following:
let l:pattern = '\v^(\d+): (\w+) (.*)$'
let l:output = []
for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:code = l:match[2]
let l:item = {
\ 'lnum': l:match[1] + 0,
\ 'text': l:code . ': ' . l:match[3],
\ 'type': 'E',
\}
call add(l:output, l:item)
endfor
return l:output
endfunction
call ale#linter#Define('gitcommit', {
\ 'name': 'gitlint',
\ 'output_stream': 'stderr',
\ 'executable_callback': 'ale_linters#gitcommit#gitlint#GetExecutable',
\ 'command_callback': 'ale_linters#gitcommit#gitlint#GetCommand',
\ 'callback': 'ale_linters#gitcommit#gitlint#Handle',
\})

42
doc/ale-gitcommit.txt Normal file
View File

@ -0,0 +1,42 @@
===============================================================================
ALE Git Commit Integration *ale-gitcommit-options*
===============================================================================
gitlint *ale-gitcommit-gitlint*
g:ale_gitcommit_gitlint_executable *g:ale_gitcommit_gitlint_executable*
*b:ale_gitcommit_gitlint_executable*
Type: |String|
Default: `'gitlint'`
This variable can be changed to modify the executable used for gitlint.
g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
*b:ale_gitcommit_gitlint_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the gitlint
invocation.
For example, to dinamically set the gitlint configuration file path, you
may want to set >
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global*
Type: |Number|
Default: `0`
This variable controls whether or not ALE will search for gitlint in a
virtualenv directory first. If this variable is set to `1`, then ALE will
always use |g:ale_gitcommit_gitlint_executable| for the executable path.
Both variables can be set with `b:` buffer variables instead.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -68,6 +68,8 @@ CONTENTS *ale-contents*
gcc.................................|ale-fortran-gcc| gcc.................................|ale-fortran-gcc|
fusionscript..........................|ale-fuse-options| fusionscript..........................|ale-fuse-options|
fusion-lint.........................|ale-fuse-fusionlint| fusion-lint.........................|ale-fuse-fusionlint|
git commit............................|ale-gitcommit-options|
gitlint.............................|ale-gitcommit-gitlint|
glsl..................................|ale-glsl-options| glsl..................................|ale-glsl-options|
glslang.............................|ale-glsl-glslang| glslang.............................|ale-glsl-glslang|
glslls..............................|ale-glsl-glslls| glslls..............................|ale-glsl-glslls|
@ -300,6 +302,7 @@ Notes:
* Erlang: `erlc`, `SyntaxErl` * Erlang: `erlc`, `SyntaxErl`
* Fortran: `gcc` * Fortran: `gcc`
* FusionScript: `fusion-lint` * FusionScript: `fusion-lint`
* Git Commit Messages: `gitlint`
* GLSL: glslang, `glslls` * GLSL: glslang, `glslls`
* Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!!
* GraphQL: `eslint`, `gqlint` * GraphQL: `eslint`, `gqlint`

View File

@ -0,0 +1,84 @@
Before:
Save g:ale_gitcommit_gitlint_executable
Save g:ale_gitcommit_gitlint_options
Save g:ale_gitcommit_gitlint_use_global
unlet! g:ale_gitcommit_gitlint_executable
unlet! g:ale_gitcommit_gitlint_options
unlet! g:ale_gitcommit_gitlint_use_global
runtime ale_linters/gitcommit/gitlint.vim
call ale#test#SetDirectory('/testplugin/test/command_callback')
let b:bin_dir = has('win32') ? 'Scripts' : 'bin'
let b:command_tail = ' lint'
After:
Restore
call ale#test#RestoreDirectory()
call ale#linter#Reset()
unlet! b:bin_dir
unlet! b:executable
Execute(The gitlint callbacks should return the correct default values):
AssertEqual
\ 'gitlint',
\ ale_linters#gitcommit#gitlint#GetExecutable(bufnr(''))
AssertEqual
\ ale#Escape('gitlint') . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))
Execute(The gitlint executable should be configurable, and escaped properly):
let g:ale_gitcommit_gitlint_executable = 'executable with spaces'
AssertEqual
\ 'executable with spaces',
\ ale_linters#gitcommit#gitlint#GetExecutable(bufnr(''))
AssertEqual
\ ale#Escape('executable with spaces') . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))
Execute(The gitlint command callback should let you set options):
let g:ale_gitcommit_gitlint_options = '--some-option'
AssertEqual
\ ale#Escape('gitlint') . ' --some-option' . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))
Execute(The gitlint callbacks shouldn't detect virtualenv directories where they don't exist):
silent execute 'file ' . fnameescape(g:dir . '/python_paths/no_virtualenv/subdir/foo/COMMIT_EDITMSG')
AssertEqual
\ 'gitlint',
\ ale_linters#gitcommit#gitlint#GetExecutable(bufnr(''))
AssertEqual
\ ale#Escape('gitlint') . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))
Execute(The gitlint callbacks should detect virtualenv directories):
silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG')
let b:executable = ale#path#Winify(
\ g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/gitlint'
\)
AssertEqual
\ b:executable,
\ ale_linters#gitcommit#gitlint#GetExecutable(bufnr(''))
AssertEqual
\ ale#Escape(b:executable) . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))
Execute(You should able able to use the global gitlint instead):
silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/COMMIT_EDITMSG')
let g:ale_gitcommit_gitlint_use_global = 1
AssertEqual
\ 'gitlint',
\ ale_linters#gitcommit#gitlint#GetExecutable(bufnr(''))
AssertEqual
\ ale#Escape('gitlint') . b:command_tail,
\ ale_linters#gitcommit#gitlint#GetCommand(bufnr(''))

View File

@ -0,0 +1,37 @@
Before:
runtime ale_linters/gitcommit/gitlint.vim
After:
call ale#linter#Reset()
Execute(The gitlint handler should handle basic warnings and syntax errors):
AssertEqual
\ [
\ {
\ 'lnum': 1,
\ 'type': 'E',
\ 'text': 'B6: Body message is missing',
\ },
\ {
\ 'lnum': 2,
\ 'type': 'E',
\ 'text': 'B4: Second line is not empty: "to send to upstream"',
\ },
\ {
\ 'lnum': 3,
\ 'type': 'E',
\ 'text': 'B5: Body message is too short (19<20): "to send to upstream"',
\ },
\ {
\ 'lnum': 8,
\ 'type': 'E',
\ 'text': 'T1: Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"'
\ },
\ ],
\ ale_linters#gitcommit#gitlint#Handle(1, [
\ '1: B6 Body message is missing',
\ '2: B4 Second line is not empty: "to send to upstream"',
\ '3: B5 Body message is too short (19<20): "to send to upstream"',
\ '8: T1 Title exceeds max length (92>72): "some very long commit subject line where the author can''t wait to explain what he just fixed"'
\ ])