/ doc / ale-gitcommit.txt
ale-gitcommit.txt
 1  ===============================================================================
 2  ALE Git Commit Integration                              *ale-gitcommit-options*
 3  
 4  
 5  ===============================================================================
 6  gitlint                                                 *ale-gitcommit-gitlint*
 7  
 8  g:ale_gitcommit_gitlint_executable         *g:ale_gitcommit_gitlint_executable*
 9                                             *b:ale_gitcommit_gitlint_executable*
10    Type: |String|
11    Default: `'gitlint'`
12  
13    This variable can be changed to modify the executable used for gitlint.
14  
15  
16  g:ale_gitcommit_gitlint_options               *g:ale_gitcommit_gitlint_options*
17                                                *b:ale_gitcommit_gitlint_options*
18    Type: |String|
19    Default: `''`
20  
21    This variable can be changed to add command-line arguments to the gitlint
22    invocation. For example, you can specify the path to a configuration file. >
23  
24      let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
25  <
26    You can also disable particular error codes using this option. For example,
27    you can ignore errors for git commits with a missing body. >
28  
29      let g:ale_gitcommit_gitlint_options = '--ignore B6'
30  <
31  
32  g:ale_gitcommit_gitlint_use_global         *g:ale_gitcommit_gitlint_use_global*
33                                             *b:ale_gitcommit_gitlint_use_global*
34    Type: |Number|
35    Default: `get(g:, 'ale_use_global_executables', 0)`
36  
37    This variable controls whether or not ALE will search for gitlint in a
38    virtualenv directory first. If this variable is set to `1`, then ALE will
39    always use |g:ale_gitcommit_gitlint_executable| for the executable path.
40  
41    Both variables can be set with `b:` buffer variables instead.
42  
43  ===============================================================================
44    vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: