summaryrefslogtreecommitdiff
path: root/doc/ale-salt.tmt
blob: ac500d373d3a667bab72f54e5207df52ab91f2d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
===============================================================================
ALE SALT Integration                                         *ale-salt-options*

===============================================================================
salt-lint                                                  *ale-salt-salt-lint*

Website: https://github.com/warpnet/salt-lint


Installation
-------------------------------------------------------------------------------

Install salt-lint in your a virtualenv directory, locally, or globally: >

  pip install salt-lint # After activating virtualenv
  pip install --user salt-lint # Install to ~/.local/bin
  sudo pip install salt-lint # Install globally

See |g:ale_virtualenv_dir_names| for configuring how ALE searches for
virtualenv directories.


Options
-------------------------------------------------------------------------------

g:ale_salt_salt-lint_executable                *g:ale_salt_salt_lint_executable*
                                               *b:ale_salt_salt_lint_executable*
  Type: |String|
  Default: `'salt-lint'`

  This variable can be set to change the path to salt-lint.


g:ale_salt_salt-lint_options                      *g:ale_salt_salt-lint_options*
                                                  *b:ale_salt_salt-lint_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to salt-lint.


===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: