summaryrefslogtreecommitdiff
path: root/doc/ale-php.txt
blob: c8874106b1ed11090e363b32054ab91fa20d622c (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
===============================================================================
ALE PHP Integration                                           *ale-php-options*


===============================================================================
hack                                                             *ale-php-hack*

There are no options for this linter.


===============================================================================
langserver                                                 *ale-php-langserver*

g:php_langserver_executable                       *g:php_langserver_executable*
                                                  *b:php_langserver_executable*
  Type: |String|
  Default: `'php-language-server.php'`

  The variable can be set to configure the executable that will be used for
  running the PHP language server. `vendor` directory executables will be
  preferred instead of this setting if |g:php_langserver_use_global| is `0`.

  See: |ale-integrations-local-executables|


g:php_langserver_use_global                       *g:php_langserver_use_global*
                                                  *b:php_langserver_use_global*
  Type: |Number|
  Default: `0`

  This variable can be set to `1` to force the language server to be run with
  the executable set for |g:php_langserver_executable|.

  See: |ale-integrations-local-executables|


===============================================================================
phpcs                                                           *ale-php-phpcs*

g:ale_php_phpcs_executable                         *g:ale_php_phpcs_executable*
                                                   *b:ale_php_phpcs_executable*
  Type: |String|
  Default: `'phpcs'`

  See |ale-integrations-local-executables|


g:ale_php_phpcs_standard                             *g:ale_php_phpcs_standard*
                                                     *b: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.


g:ale_php_phpcs_use_global                         *g:ale_php_phpcs_use_global*
                                                   *b:ale_php_phpcs_use_global*
  Type: |Number|
  Default: `0`

  See |ale-integrations-local-executables|


------------------------------------------------------------------------------
phpmd                                                           *ale-php-phpmd*

g:ale_php_phpmd_ruleset                               *g:ale_php_phpmd_ruleset*
                                                      *b: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


------------------------------------------------------------------------------
phpstan                                                          *ale-php-stan*

g:ale_php_phpstan_executable                     *g:ale_php_phpstan_executable*
                                                 *b:ale_php_phpstan_executable*
  Type: |String|
  Default: `'phpstan'`

  This variable sets executable used for phpstan.


g:ale_php_phpstan_level                               *g:ale_php_phpstan_level*
                                                      *b:ale_php_phpstan_level*
  Type: |Number|
  Default: `4`

  This variable controls the rule levels. 0 is the loosest and 4 is the
  strictest.

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