doc/ale-gitcommit.txt

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