summaryrefslogtreecommitdiff
path: root/doc/ale-php.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-03-28 23:25:44 +0100
committerw0rp <devw0rp@gmail.com>2017-03-28 23:25:44 +0100
commitd7f8324c3c9b9eb6ea49591fc4fa37948996170d (patch)
tree8a342445f96fbbb904895babba106139c7dc22a2 /doc/ale-php.txt
parent094eeb267397acdc7eb35498f06088aec1eb339a (diff)
downloadale-d7f8324c3c9b9eb6ea49591fc4fa37948996170d.zip
Move linter documentation into separate files
Diffstat (limited to 'doc/ale-php.txt')
-rw-r--r--doc/ale-php.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
new file mode 100644
index 00000000..99ce1291
--- /dev/null
+++ b/doc/ale-php.txt
@@ -0,0 +1,31 @@
+===============================================================================
+ALE PHP Integration *ale-php-options*
+
+
+-------------------------------------------------------------------------------
+phpcs *ale-php-phpcs*
+
+g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
+
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to specify the coding standard used by phpcs. If no
+ coding standard is specified, phpcs will default to checking against the
+ PEAR coding standard, or the standard you have set as the default.
+
+
+------------------------------------------------------------------------------
+phpmd *ale-php-phpmd*
+
+g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
+
+ Type: |String|
+ Default: `'cleancode,codesize,controversial,design,naming,unusedcode'`
+
+ This variable controls the ruleset used by phpmd. Default is to use all of
+ the available phpmd rulesets
+
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: