summaryrefslogtreecommitdiff
path: root/doc/ale-perl.txt
diff options
context:
space:
mode:
authorChris Weyl <chris@weyl.io>2017-06-29 07:08:51 -0500
committerw0rp <w0rp@users.noreply.github.com>2017-06-29 13:08:51 +0100
commit3f1cab3e7ee3d7e90062e32e7d8c9557077c08a8 (patch)
treea4871ee9fdd2ef91a2c825e26e12b12d25965f86 /doc/ale-perl.txt
parent411c6b5e9f8ecf367aaf487adf4e380251c44fa1 (diff)
downloadale-3f1cab3e7ee3d7e90062e32e7d8c9557077c08a8.zip
Add profile, other options to the perlcritic linter (#675)
* Add profile, other options to the perlcritic linter
Diffstat (limited to 'doc/ale-perl.txt')
-rw-r--r--doc/ale-perl.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt
index 8349dff7..4425bda5 100644
--- a/doc/ale-perl.txt
+++ b/doc/ale-perl.txt
@@ -25,6 +25,37 @@ g:ale_perl_perl_options *g:ale_perl_perl_options*
-------------------------------------------------------------------------------
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 using a profile.
+
+
+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|