diff options
| author | Nick Diego Yamane <nick.diego@gmail.com> | 2017-12-20 06:10:07 -0400 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2017-12-20 10:10:07 +0000 |
| commit | d4b43d23f4a9f277a482fdad4ea3a3e951d80eab (patch) | |
| tree | 0d66493a39ced077df4c978b0f1b1f3f30db80ba /doc | |
| parent | 1568bf81281507aaaa8c71af85e244e94bd2924c (diff) | |
| download | ale-d4b43d23f4a9f277a482fdad4ea3a3e951d80eab.zip | |
Add support for linting git commit message files (#1233)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-gitcommit.txt | 42 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 45 insertions, 0 deletions
diff --git a/doc/ale-gitcommit.txt b/doc/ale-gitcommit.txt new file mode 100644 index 00000000..71813dd0 --- /dev/null +++ b/doc/ale-gitcommit.txt @@ -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: diff --git a/doc/ale.txt b/doc/ale.txt index bdcb39fe..7cc6b22a 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -68,6 +68,8 @@ CONTENTS *ale-contents* gcc.................................|ale-fortran-gcc| fusionscript..........................|ale-fuse-options| fusion-lint.........................|ale-fuse-fusionlint| + git commit............................|ale-gitcommit-options| + gitlint.............................|ale-gitcommit-gitlint| glsl..................................|ale-glsl-options| glslang.............................|ale-glsl-glslang| glslls..............................|ale-glsl-glslls| @@ -300,6 +302,7 @@ Notes: * Erlang: `erlc`, `SyntaxErl` * Fortran: `gcc` * FusionScript: `fusion-lint` +* Git Commit Messages: `gitlint` * GLSL: glslang, `glslls` * Go: `gofmt`, `goimports`, `go vet`, `golint`, `gometalinter`!!, `go build`!!, `gosimple`!!, `staticcheck`!! * GraphQL: `eslint`, `gqlint` |