mirror of
https://github.com/dense-analysis/ale.git
synced 2025-12-06 12:44:23 +08:00
b415dddf9f
Some checks failed
CI / build_image (push) Has been cancelled
CI / test_ale (--linters-only) (push) Has been cancelled
CI / test_ale (--lua-only) (push) Has been cancelled
CI / test_ale (--neovim-07-only) (push) Has been cancelled
CI / test_ale (--neovim-08-only) (push) Has been cancelled
CI / test_ale (--vim-80-only) (push) Has been cancelled
CI / test_ale (--vim-90-only) (push) Has been cancelled
Add php_phpactor_executable for phpactor and make it configurable
through php_phpactor_config.
When phpactor was first added in 3b8ff65, it had no configuration. Thus
the documentation for it could be completely blank. That is why it now
seems like an initial addition
Co-authored-by: cos <cos>
482 lines
19 KiB
Plaintext
482 lines
19 KiB
Plaintext
===============================================================================
|
|
ALE PHP Integration *ale-php-options*
|
|
|
|
|
|
===============================================================================
|
|
cspell *ale-php-cspell*
|
|
|
|
See |ale-cspell-options|
|
|
|
|
|
|
===============================================================================
|
|
langserver *ale-php-langserver*
|
|
|
|
*ale-options.php_langserver_executable*
|
|
*g:ale_php_langserver_executable*
|
|
*b:ale_php_langserver_executable*
|
|
php_langserver_executable
|
|
g:ale_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:ale_php_langserver_use_global| is `0`.
|
|
|
|
See: |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_langserver_use_global*
|
|
*g:ale_php_langserver_use_global*
|
|
*b:ale_php_langserver_use_global*
|
|
php_langserver_use_global
|
|
g:ale_php_langserver_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
This variable can be set to `1` to force the language server to be run with
|
|
the executable set for |g:ale_php_langserver_executable|.
|
|
|
|
See: |ale-integrations-local-executables|
|
|
|
|
|
|
===============================================================================
|
|
phan *ale-php-phan*
|
|
|
|
WARNING: please use the phan_client linter if you have an configuration file
|
|
for your project because the phan will look into your entirely project and
|
|
ale will display in the current buffer warnings that may belong to other file.
|
|
|
|
*ale-options.php_phan_minimum_severity*
|
|
*g:ale_php_phan_minimum_severity*
|
|
*b:ale_php_phan_minimum_severity*
|
|
php_phan_minimum_severity
|
|
g:ale_php_phan_minimum_severity
|
|
Type: |Number|
|
|
Default: `0`
|
|
|
|
This variable defines the minimum severity level.
|
|
|
|
*ale-options.php_phan_executable*
|
|
*g:ale_php_phan_executable*
|
|
*b:ale_php_phan_executable*
|
|
php_phan_executable
|
|
g:ale_php_phan_executable
|
|
Type: |String|
|
|
Default: `'phan'`
|
|
|
|
This variable sets executable used for phan or phan_client.
|
|
|
|
*ale-options.php_phan_use_client*
|
|
*g:ale_php_phan_use_client*
|
|
*b:ale_php_phan_use_client*
|
|
php_phan_use_client
|
|
g:ale_php_phan_use_client
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_php_phan_use_client', 0)`
|
|
|
|
This variable can be set to 1 to use the phan_client with phan daemon mode
|
|
instead of the phan standalone.
|
|
|
|
|
|
===============================================================================
|
|
phpactor *ale-php-phpactor*
|
|
|
|
*ale-options.php_phpactor_executable*
|
|
*g:ale_php_phpactor_executable*
|
|
*b:ale_php_phpactor_executable*
|
|
php_phpactor_executable
|
|
g:ale_php_phpactor_executable
|
|
Type: |String|
|
|
Default: `'phpactor'`
|
|
|
|
This variable sets executable used for phpactor.
|
|
|
|
php_phpactor_init_options
|
|
g:ale_php_phpactor_init_options
|
|
Type: |Dictionary|
|
|
Default: `'{}'`
|
|
|
|
This variable can be changed to customize the LSP initialization_options.
|
|
For example: >
|
|
|
|
let g:ale_php_phpactor_init_options = {
|
|
\ 'language_server_phpstan.enabled': v:false,
|
|
\ 'language_server_psalm.enabled': v:false,
|
|
\ 'worse_reflection.stub_dir': '%application_root%/.php-stubs'
|
|
\}
|
|
<
|
|
For all available options and explanations, visit
|
|
https://phpactor.readthedocs.io/en/master/reference/configuration.html
|
|
|
|
===============================================================================
|
|
phpcbf *ale-php-phpcbf*
|
|
|
|
*ale-options.php_phpcbf_executable*
|
|
*g:ale_php_phpcbf_executable*
|
|
*b:ale_php_phpcbf_executable*
|
|
php_phpcbf_executable
|
|
g:ale_php_phpcbf_executable
|
|
Type: |String|
|
|
Default: `'phpcbf'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_phpcbf_standard*
|
|
*g:ale_php_phpcbf_standard*
|
|
*b:ale_php_phpcbf_standard*
|
|
php_phpcbf_standard
|
|
g:ale_php_phpcbf_standard
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to specify the coding standard used by phpcbf. If no
|
|
coding standard is specified, phpcbf will default to fixing against the
|
|
PEAR coding standard, or the standard you have set as the default.
|
|
|
|
*ale-options.php_phpcbf_use_global*
|
|
*g:ale_php_phpcbf_use_global*
|
|
*b:ale_php_phpcbf_use_global*
|
|
php_phpcbf_use_global
|
|
g:ale_php_phpcbf_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_phpcbf_options*
|
|
*g:ale_php_phpcbf_options*
|
|
*b:ale_php_phpcbf_options*
|
|
php_phpcbf_options
|
|
g:ale_php_phpcbf_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to php-cbf
|
|
|
|
|
|
===============================================================================
|
|
phpcs *ale-php-phpcs*
|
|
|
|
*ale-options.php_phpcs_executable*
|
|
*g:ale_php_phpcs_executable*
|
|
*b:ale_php_phpcs_executable*
|
|
php_phpcs_executable
|
|
g:ale_php_phpcs_executable
|
|
Type: |String|
|
|
Default: `'phpcs'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_phpcs_standard*
|
|
*g:ale_php_phpcs_standard*
|
|
*b:ale_php_phpcs_standard*
|
|
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.
|
|
|
|
*ale-options.php_phpcs_use_global*
|
|
*g:ale_php_phpcs_use_global*
|
|
*b:ale_php_phpcs_use_global*
|
|
php_phpcs_use_global
|
|
g:ale_php_phpcs_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_phpcs_options*
|
|
*g:ale_php_phpcs_options*
|
|
*b:ale_php_phpcs_options*
|
|
php_phpcs_options
|
|
g:ale_php_phpcs_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to php-cs
|
|
|
|
|
|
===============================================================================
|
|
phpmd *ale-php-phpmd*
|
|
|
|
*ale-options.php_phpmd_executable*
|
|
*g:ale_php_phpmd_executable*
|
|
*b:ale_php_phpmd_executable*
|
|
php_phpmd_executable
|
|
g:ale_php_phpmd_executable
|
|
Type: |String|
|
|
Default: `'phpmd'`
|
|
|
|
This variable sets executable used for phpmd.
|
|
|
|
*ale-options.php_phpmd_ruleset*
|
|
*g:ale_php_phpmd_ruleset*
|
|
*b:ale_php_phpmd_ruleset*
|
|
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
|
|
|
|
|
|
===============================================================================
|
|
phpstan *ale-php-phpstan*
|
|
|
|
*ale-options.php_phpstan_executable*
|
|
*g:ale_php_phpstan_executable*
|
|
*b:ale_php_phpstan_executable*
|
|
php_phpstan_executable
|
|
g:ale_php_phpstan_executable
|
|
Type: |String|
|
|
Default: `'phpstan'`
|
|
|
|
This variable sets executable used for phpstan.
|
|
|
|
*ale-options.php_phpstan_level*
|
|
*g:ale_php_phpstan_level*
|
|
*b:ale_php_phpstan_level*
|
|
php_phpstan_level
|
|
g:ale_php_phpstan_level
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable controls the rule levels. 0 is the loosest and 7 is the
|
|
strictest. If this option isn't set, the rule level will be controlled by
|
|
the configuration file. If no configuration file can be detected, `'7'` will
|
|
be used instead.
|
|
|
|
*ale-options.php_phpstan_configuration*
|
|
*g:ale_php_phpstan_configuration*
|
|
*b:ale_php_phpstan_configuration*
|
|
php_phpstan_configuration
|
|
g:ale_php_phpstan_configuration
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable sets path to phpstan configuration file.
|
|
|
|
*ale-options.php_phpstan_autoload*
|
|
*g:ale_php_phpstan_autoload*
|
|
*b:ale_php_phpstan_autoload*
|
|
php_phpstan_autoload
|
|
g:ale_php_phpstan_autoload
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable sets path to phpstan autoload file.
|
|
|
|
*ale-options.php_phpstan_memory_limit*
|
|
*g:ale_php_phpstan_memory_limit*
|
|
*b:ale_php_phpstan_memory-limit*
|
|
php_phpstan_memory_limit
|
|
g:ale_php_phpstan_memory_limit
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable sets the memory limit for phpstan analysis. This is a string
|
|
in the same format as `php.ini` accepts, e.g. `128M`, `1G`.
|
|
|
|
|
|
===============================================================================
|
|
psalm *ale-php-psalm*
|
|
|
|
*ale-options.php_psalm_executable*
|
|
*g:ale_php_psalm_executable*
|
|
*b:ale_php_psalm_executable*
|
|
php_psalm_executable
|
|
g:ale_php_psalm_executable
|
|
Type: |String|
|
|
Default: `'psalm'`
|
|
|
|
This variable sets the executable used for psalm.
|
|
|
|
*ale-options.php_psalm_options*
|
|
*g:ale_php_psalm_options*
|
|
*b:ale_php_psalm_options*
|
|
php_psalm_options
|
|
g:ale_php_psalm_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to psalm.
|
|
|
|
*ale-options.php_psalm_use_global*
|
|
*g:ale_php_psalm_use_global*
|
|
*b:ale_php_psalm_use_global*
|
|
php_psalm_use_global
|
|
g:ale_php_psalm_use_global
|
|
Type: |Boolean|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
|
|
===============================================================================
|
|
php-cs-fixer *ale-php-php-cs-fixer*
|
|
|
|
*ale-options.php_cs_fixer_executable*
|
|
*g:ale_php_cs_fixer_executable*
|
|
*b:ale_php_cs_fixer_executable*
|
|
php_cs_fixer_executable
|
|
g:ale_php_cs_fixer_executable
|
|
Type: |String|
|
|
Default: `'php-cs-fixer'`
|
|
|
|
This variable sets executable used for php-cs-fixer.
|
|
|
|
*ale-options.php_cs_fixer_options*
|
|
*g:ale_php_cs_fixer_options*
|
|
*b:ale_php_cs_fixer_options*
|
|
php_cs_fixer_options
|
|
g:ale_php_cs_fixer_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to php-cs-fixer.
|
|
|
|
*ale-options.php_cs_fixer_use_global*
|
|
*g:ale_php_cs_fixer_use_global*
|
|
*b:ale_php_cs_fixer_use_global*
|
|
php_cs_fixer_use_global
|
|
g:ale_php_cs_fixer_use_global
|
|
Type: |Boolean|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
|
|
===============================================================================
|
|
php *ale-php-php*
|
|
|
|
*ale-options.php_php_executable*
|
|
*g:ale_php_php_executable*
|
|
*b:ale_php_php_executable*
|
|
php_php_executable
|
|
g:ale_php_php_executable
|
|
Type: |String|
|
|
Default: `'php'`
|
|
|
|
This variable sets the executable used for php.
|
|
|
|
|
|
===============================================================================
|
|
pint *ale-php-pint*
|
|
|
|
*ale-options.php_pint_executable*
|
|
*g:ale_php_pint_executable*
|
|
*b:ale_php_pint_executable*
|
|
php_pint_executable
|
|
g:ale_php_pint_executable
|
|
Type: |String|
|
|
Default: `'pint'`
|
|
|
|
This variable sets the executable used for pint.
|
|
|
|
*ale-options.php_pint_options*
|
|
*g:ale_php_pint_options*
|
|
*b:ale_php_pint_options*
|
|
php_pint_options
|
|
g:ale_php_pint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to pint.
|
|
|
|
*ale-options.php_pint_use_global*
|
|
*g:ale_php_pint_use_global*
|
|
*b:ale_php_pint_use_global*
|
|
php_pint_use_global
|
|
g:ale_php_pint_use_global
|
|
Type: |Boolean|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
|
|
===============================================================================
|
|
tlint *ale-php-tlint*
|
|
|
|
*ale-options.php_tlint_executable*
|
|
*g:ale_php_tlint_executable*
|
|
*b:ale_php_tlint_executable*
|
|
php_tlint_executable
|
|
g:ale_php_tlint_executable
|
|
Type: |String|
|
|
Default: `'tlint'`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_tlint_use_global*
|
|
*g:ale_php_tlint_use_global*
|
|
*b:ale_php_tlint_use_global*
|
|
php_tlint_use_global
|
|
g:ale_php_tlint_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
See |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_tlint_options*
|
|
*g:ale_php_tlint_options*
|
|
*b:ale_php_tlint_options*
|
|
php_tlint_options
|
|
g:ale_php_tlint_options
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be set to pass additional options to tlint
|
|
|
|
|
|
===============================================================================
|
|
intelephense *ale-php-intelephense*
|
|
|
|
*ale-options.php_intelephense_executable*
|
|
*g:ale_php_intelephense_executable*
|
|
*b:ale_php_intelephense_executable*
|
|
php_intelephense_executable
|
|
g:ale_php_intelephense_executable
|
|
Type: |String|
|
|
Default: `'intelephense'`
|
|
|
|
The variable can be set to configure the executable that will be used for
|
|
running the intelephense language server. `node_modules` directory
|
|
executable will be preferred instead of this setting if
|
|
|g:ale_php_intelephense_use_global| is `0`.
|
|
|
|
See: |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_intelephense_use_global*
|
|
*g:ale_php_intelephense_use_global*
|
|
*b:ale_php_intelephense_use_global*
|
|
php_intelephense_use_global
|
|
g:ale_php_intelephense_use_global
|
|
Type: |Number|
|
|
Default: `get(g:, 'ale_use_global_executables', 0)`
|
|
|
|
This variable can be set to `1` to force the language server to be run with
|
|
the executable set for |g:ale_php_intelephense_executable|.
|
|
|
|
See: |ale-integrations-local-executables|
|
|
|
|
*ale-options.php_intelephense_config*
|
|
*g:ale_php_intelephense_config*
|
|
*b:ale_php_intelephense_config*
|
|
php_intelephense_config
|
|
g:ale_php_intelephense_config
|
|
Type: |Dictionary|
|
|
Default: `{}`
|
|
|
|
The initialization options config specified by Intelephense. Refer to the
|
|
installation docs provided by intelephense (github.com/bmewburn/intelephense
|
|
-docs).
|
|
|
|
|
|
===============================================================================
|
|
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|