summaryrefslogtreecommitdiff
path: root/doc/ale-perl.txt
blob: ae50d6157ee825e15fa2cce6f68ea5c82c0d0bf0 (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
===============================================================================
ALE Perl Integration                                         *ale-perl-options*


-------------------------------------------------------------------------------
perl                                                            *ale-perl-perl*

g:ale_perl_perl_executable                         *g:ale_perl_perl_executable*
                                                   *b:ale_perl_perl_executable*
  Type: |String|
  Default: `'perl'`

  This variable can be changed to modify the executable used for linting perl.


g:ale_perl_perl_options                               *g:ale_perl_perl_options*
                                                      *b:ale_perl_perl_options*
  Type: |String|
  Default: `'-c -Mwarnings -Ilib'`

  This variable can be changed to alter the command-line arguments to the perl
  invocation.


-------------------------------------------------------------------------------
perlcritic                                                *ale-perl-perlcritic*

g:ale_perl_perlcritic_executable              *g:ale_perl_perlcritic_executable*
                                              *b:ale_perl_perlcritic_executable*
  Type: |String|
  Default: `'perlcritic'`

  This variable can be changed to modify the perlcritic executable used for
  linting perl.


g:ale_perl_perlcritic_profile                    *g:ale_perl_perlcritic_profile*
                                                 *b:ale_perl_perlcritic_profile*
  Type: |String|
  Default: `'.perlcriticrc'`

  This variable can be changed to modify the perlcritic profile used for
  linting perl.  The current directory is checked for the file, then the
  parent directory, etc, until it finds one.  If no matching file is found, no
  profile is passed to perlcritic.

  Set to an empty string to disable passing a specific profile to perlcritic
  with the `'--profile'` option.

  To prevent perlcritic from using any profile, set this variable to an empty
  string and pass `'--no-profile'`to perlcritic via the
  |g:ale_perl_perlcritic_options| variable.


g:ale_perl_perlcritic_options                    *g:ale_perl_perlcritic_options*
                                                 *b:ale_perl_perlcritic_options*
  Type: |String|
  Default: `''`

  This variable can be changed to supply additional command-line arguments to
  the perlcritic invocation.


g:ale_perl_perlcritic_showrules               *g:ale_perl_perlcritic_showrules*

  Type: |Number|
  Default: 0

  Controls whether perlcritic rule names are shown after the error message.
  Defaults to off to reduce length of message.


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