Files
ale/doc/ale-perl.txt
w0rp 400857d758 Implement Lua ALE setup & overhaul documentation
1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
2025-03-27 12:40:11 +00:00

111 lines
4.5 KiB
Plaintext

===============================================================================
ALE Perl Integration *ale-perl-options*
ALE offers a few ways to check Perl code. Checking code with `perl` is
disabled by default, as `perl` code cannot be checked without executing it.
Specifically, we use the `-c` flag to see if `perl` code compiles. This does
not execute all of the code in a file, but it does run `BEGIN` and `CHECK`
blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224
See |g:ale_linters|.
===============================================================================
perl *ale-perl-perl*
*ale-options.perl_perl_executable*
*g:ale_perl_perl_executable*
*b:ale_perl_perl_executable*
perl_perl_executable
g:ale_perl_perl_executable
Type: |String|
Default: `'perl'`
This variable can be changed to modify the executable used for linting perl.
*ale-options.perl_perl_options*
*g:ale_perl_perl_options*
*b:ale_perl_perl_options*
perl_perl_options
g: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*
*ale-options.perl_perlcritic_executable*
*g:ale_perl_perlcritic_executable*
*b:ale_perl_perlcritic_executable*
perl_perlcritic_executable
g:ale_perl_perlcritic_executable
Type: |String|
Default: `'perlcritic'`
This variable can be changed to modify the perlcritic executable used for
linting perl.
*ale-options.perl_perlcritic_profile*
*g:ale_perl_perlcritic_profile*
*b:ale_perl_perlcritic_profile*
perl_perlcritic_profile
g: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.
*ale-options.perl_perlcritic_options*
*g:ale_perl_perlcritic_options*
*b:ale_perl_perlcritic_options*
perl_perlcritic_options
g:ale_perl_perlcritic_options
Type: |String|
Default: `''`
This variable can be changed to supply additional command-line arguments to
the perlcritic invocation.
*ale-options.perl_perlcritic_showrules*
*g:ale_perl_perlcritic_showrules*
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.
===============================================================================
perltidy *ale-perl-perltidy*
*ale-options.perl_perltidy_options*
*g:ale_perl_perltidy_options*
*b:ale_perl_perltidy_options*
perl_perltidy_options
g:ale_perl_perltidy_options
Type: |String|
Default: `''`
This variable can be changed to alter the command-line arguments to
the perltidy invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: