Document the PHP langserver integration

This commit is contained in:
w0rp 2017-08-07 13:08:51 +01:00
parent f7d7abe5b2
commit 39ebb431b6
4 changed files with 36 additions and 3 deletions

View File

@ -99,7 +99,7 @@ name. That seems to be the fairest way to arrange this table.
| Objective-C++ | [clang](http://clang.llvm.org/) | | Objective-C++ | [clang](http://clang.llvm.org/) |
| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-ocaml-merlin` for configuration instructions | OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-ocaml-merlin` for configuration instructions
| Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) | | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) |
| PHP | [hack](http://hacklang.org/), [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan) | | PHP | [hack](http://hacklang.org/), [langserver](https://github.com/felixfbecker/php-language-server), [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan) |
| Pod | [proselint](http://proselint.com/)| | Pod | [proselint](http://proselint.com/)|
| Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Pug | [pug-lint](https://github.com/pugjs/pug-lint) |
| Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) |

View File

@ -2,7 +2,6 @@
" Description: PHP Language server integration for ALE " Description: PHP Language server integration for ALE
call ale#Set('php_langserver_executable', 'php-language-server.php') call ale#Set('php_langserver_executable', 'php-language-server.php')
call ale#Set('php_langserver_config_path', '')
call ale#Set('php_langserver_use_global', 0) call ale#Set('php_langserver_use_global', 0)
function! ale_linters#php#langserver#GetExecutable(buffer) abort function! ale_linters#php#langserver#GetExecutable(buffer) abort

View File

@ -2,6 +2,38 @@
ALE PHP Integration *ale-php-options* 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* phpcs *ale-php-phpcs*

View File

@ -75,6 +75,8 @@ CONTENTS *ale-contents*
perl................................|ale-perl-perl| perl................................|ale-perl-perl|
perlcritic..........................|ale-perl-perlcritic| perlcritic..........................|ale-perl-perlcritic|
php...................................|ale-php-options| php...................................|ale-php-options|
hack................................|ale-php-hack|
langserver..........................|ale-php-langserver|
phpcs...............................|ale-php-phpcs| phpcs...............................|ale-php-phpcs|
phpmd...............................|ale-php-phpmd| phpmd...............................|ale-php-phpmd|
phpstan.............................|ale-php-phpstan| phpstan.............................|ale-php-phpstan|
@ -204,7 +206,7 @@ The following languages and tools are supported.
* Objective-C++: 'clang' * Objective-C++: 'clang'
* OCaml: 'merlin' (see |ale-linter-integration-ocaml-merlin|) * OCaml: 'merlin' (see |ale-linter-integration-ocaml-merlin|)
* Perl: 'perl' (-c flag), 'perlcritic' * Perl: 'perl' (-c flag), 'perlcritic'
* PHP: 'hack', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan' * PHP: 'hack', 'langserver', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan'
* Pod: 'proselint' * Pod: 'proselint'
* Pug: 'pug-lint' * Pug: 'pug-lint'
* Puppet: 'puppet', 'puppet-lint' * Puppet: 'puppet', 'puppet-lint'