VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-02-26 19:47:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implement Lua ALE setup & overhaul documentation

Browse Source 
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.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
doc/ale-php.txt
View File

@@ -11,8 +11,11 @@ See |ale-cspell-options|
===============================================================================
langserver *ale-php-langserver*
g:ale_php_langserver_executable *g:ale_php_langserver_executable*
*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'`
@@ -22,9 +25,11 @@ g:ale_php_langserver_executable *g:ale_php_langserver_executable*
See: |ale-integrations-local-executables|
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
*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)`
@@ -41,24 +46,31 @@ 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.
g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity*
*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.
g:ale_php_phan_executable *g:ale_php_phan_executable*
*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.
g:ale_php_phan_use_client *g:ale_php_phan_use_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)`
@@ -69,16 +81,21 @@ g:ale_php_phan_use_client *g:ale_php_phan_use_client*
===============================================================================
phpcbf *ale-php-phpcbf*
g:ale_php_phpcbf_executable *g:ale_php_phpcbf_executable*
*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|
g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
*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: `''`
@@ -86,17 +103,21 @@ g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
coding standard is specified, phpcbf will default to fixing against the
PEAR coding standard, or the standard you have set as the default.
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
*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|
g:ale_php_phpcbf_options *g:ale_php_phpcbf_options*
*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: `''`
@@ -106,16 +127,21 @@ g:ale_php_phpcbf_options *g:ale_php_phpcbf_options*
===============================================================================
phpcs *ale-php-phpcs*
g:ale_php_phpcs_executable *g:ale_php_phpcs_executable*
*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|
g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
*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: `''`
@@ -123,17 +149,21 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
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*
*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|
g:ale_php_phpcs_options *g:ale_php_phpcs_options*
*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: `''`
@@ -143,16 +173,21 @@ g:ale_php_phpcs_options *g:ale_php_phpcs_options*
===============================================================================
phpmd *ale-php-phpmd*
g:ale_php_phpmd_executable *g:ale_php_phpmd_executable*
*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.
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
*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'`
@@ -163,16 +198,21 @@ g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
===============================================================================
phpstan *ale-php-phpstan*
g:ale_php_phpstan_executable *g:ale_php_phpstan_executable*
*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.
g:ale_php_phpstan_level *g:ale_php_phpstan_level*
*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: `''`
@@ -181,25 +221,31 @@ g:ale_php_phpstan_level *g:ale_php_phpstan_level*
the configuration file. If no configuration file can be detected, `'7'` will
be used instead.
g:ale_php_phpstan_configuration *g:ale_php_phpstan_configuration*
*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.
g:ale_php_phpstan_autoload *g:ale_php_phpstan_autoload*
*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.
g:ale_php_phpstan_memory_limit *g:ale_php_phpstan_memory-limit*
*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: `''`
@@ -210,24 +256,31 @@ g:ale_php_phpstan_memory_limit *g:ale_php_phpstan_memory-limit*
===============================================================================
psalm *ale-php-psalm*
g:ale_php_psalm_executable *g:ale_php_psalm_executable*
*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.
g:ale_php_psalm_options *g:ale_php_psalm_options*
*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.
g:ale_php_psalm_use_global *g:ale_php_psalm_use_global*
*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)`
@@ -237,24 +290,31 @@ g:ale_php_psalm_use_global *g:ale_php_psalm_use_global*
===============================================================================
php-cs-fixer *ale-php-php-cs-fixer*
g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable*
*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.
g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options*
*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.
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
*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)`
@@ -264,8 +324,11 @@ g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
===============================================================================
php *ale-php-php*
g:ale_php_php_executable *g:ale_php_php_executable*
*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'`
@@ -275,24 +338,31 @@ g:ale_php_php_executable *g:ale_php_php_executable*
===============================================================================
pint *ale-php-pint*
g:ale_php_pint_executable *g:ale_php_pint_executable*
*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.
g:ale_php_pint_options *g:ale_php_pint_options*
*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.
g:ale_php_pint_use_global *g:ale_php_pint_use_global*
*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)`
@@ -302,24 +372,31 @@ g:ale_php_pint_use_global *g:ale_php_pint_use_global*
===============================================================================
tlint *ale-php-tlint*
g:ale_php_tlint_executable *g:ale_php_tlint_executable*
*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|
g:ale_php_tlint_use_global *g:ale_php_tlint_use_global*
*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|
g:ale_php_tlint_options *g:ale_php_tlint_options*
*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: `''`
@@ -329,8 +406,11 @@ g:ale_php_tlint_options *g:ale_php_tlint_options*
===============================================================================
intelephense *ale-php-intelephense*
g:ale_php_intelephense_executable *g:ale_php_intelephense_executable*
*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'`
@@ -341,9 +421,11 @@ g:ale_php_intelephense_executable *g:ale_php_intelephense_executable*
See: |ale-integrations-local-executables|
g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global*
*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)`
@@ -352,9 +434,11 @@ g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global*
See: |ale-integrations-local-executables|
g:ale_php_intelephense_config *g:ale_php_intelephense_config*
*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: `{}`