.vim/bundle/ale/doc/ale-perl.txt

   1 ===============================================================================
   2 ALE Perl Integration                                         *ale-perl-options*
   3
   4 ALE offers a few ways to check Perl code. Checking code with `perl` is
   5 disabled by default, as `perl` code cannot be checked without executing it.
   6 Specifically, we use the `-c` flag to see if `perl` code compiles. This does
   7 not execute all of the code in a file, but it does run `BEGIN` and `CHECK`
   8 blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224
   9
  10 See |g:ale_linters|.
  11
  12
  13 ===============================================================================
  14 perl                                                            *ale-perl-perl*
  15
  16                                              *ale-options.perl_perl_executable*
  17                                                    *g:ale_perl_perl_executable*
  18                                                    *b:ale_perl_perl_executable*
  19 perl_perl_executable
  20 g:ale_perl_perl_executable
  21   Type: |String|
  22   Default: `'perl'`
  23
  24   This variable can be changed to modify the executable used for linting perl.
  25
  26                                                 *ale-options.perl_perl_options*
  27                                                       *g:ale_perl_perl_options*
  28                                                       *b:ale_perl_perl_options*
  29 perl_perl_options
  30 g:ale_perl_perl_options
  31   Type: |String|
  32   Default: `'-c -Mwarnings -Ilib'`
  33
  34   This variable can be changed to alter the command-line arguments to the perl
  35   invocation.
  36
  37
  38 ===============================================================================
  39 perlcritic                                                *ale-perl-perlcritic*
  40
  41                                        *ale-options.perl_perlcritic_executable*
  42                                              *g:ale_perl_perlcritic_executable*
  43                                              *b:ale_perl_perlcritic_executable*
  44 perl_perlcritic_executable
  45 g:ale_perl_perlcritic_executable
  46   Type: |String|
  47   Default: `'perlcritic'`
  48
  49   This variable can be changed to modify the perlcritic executable used for
  50   linting perl.
  51
  52                                           *ale-options.perl_perlcritic_profile*
  53                                                 *g:ale_perl_perlcritic_profile*
  54                                                 *b:ale_perl_perlcritic_profile*
  55 perl_perlcritic_profile
  56 g:ale_perl_perlcritic_profile
  57   Type: |String|
  58   Default: `'.perlcriticrc'`
  59
  60   This variable can be changed to modify the perlcritic profile used for
  61   linting perl.  The current directory is checked for the file, then the
  62   parent directory, etc, until it finds one.  If no matching file is found, no
  63   profile is passed to perlcritic.
  64
  65   Set to an empty string to disable passing a specific profile to perlcritic
  66   with the `'--profile'` option.
  67
  68   To prevent perlcritic from using any profile, set this variable to an empty
  69   string and pass `'--no-profile'`to perlcritic via the
  70   |g:ale_perl_perlcritic_options| variable.
  71
  72                                           *ale-options.perl_perlcritic_options*
  73                                                 *g:ale_perl_perlcritic_options*
  74                                                 *b:ale_perl_perlcritic_options*
  75 perl_perlcritic_options
  76 g:ale_perl_perlcritic_options
  77   Type: |String|
  78   Default: `''`
  79
  80   This variable can be changed to supply additional command-line arguments to
  81   the perlcritic invocation.
  82
  83                                         *ale-options.perl_perlcritic_showrules*
  84                                               *g:ale_perl_perlcritic_showrules*
  85 perl_perlcritic_showrules
  86 g:ale_perl_perlcritic_showrules
  87   Type: |Number|
  88   Default: `0`
  89
  90   Controls whether perlcritic rule names are shown after the error message.
  91   Defaults to off to reduce length of message.
  92
  93
  94 ===============================================================================
  95 perltidy                                                    *ale-perl-perltidy*
  96
  97                                             *ale-options.perl_perltidy_options*
  98                                                   *g:ale_perl_perltidy_options*
  99                                                   *b:ale_perl_perltidy_options*
 100 perl_perltidy_options
 101 g:ale_perl_perltidy_options
 102   Type: |String|
 103   Default: `''`
 104
 105   This variable can be changed to alter the command-line arguments to
 106   the perltidy invocation.
 107
 108
 109 ===============================================================================
 110   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: