From 39ebb431b6ebc2045c65fc0096ebee8a495478e0 Mon Sep 17 00:00:00 2001 From: w0rp Date: Mon, 7 Aug 2017 13:08:51 +0100 Subject: [PATCH] Document the PHP langserver integration --- README.md | 2 +- ale_linters/php/langserver.vim | 1 - doc/ale-php.txt | 32 ++++++++++++++++++++++++++++++++ doc/ale.txt | 4 +++- 4 files changed, 36 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e88b31b..7c05feb 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ name. That seems to be the fairest way to arrange this table. | 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 | 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/)| | Pug | [pug-lint](https://github.com/pugjs/pug-lint) | | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) | diff --git a/ale_linters/php/langserver.vim b/ale_linters/php/langserver.vim index d772e90..be2d6ef 100644 --- a/ale_linters/php/langserver.vim +++ b/ale_linters/php/langserver.vim @@ -2,7 +2,6 @@ " Description: PHP Language server integration for ALE 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) function! ale_linters#php#langserver#GetExecutable(buffer) abort diff --git a/doc/ale-php.txt b/doc/ale-php.txt index 4109673..c887410 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -2,6 +2,38 @@ 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* diff --git a/doc/ale.txt b/doc/ale.txt index 1c43910..5eff73b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -75,6 +75,8 @@ CONTENTS *ale-contents* perl................................|ale-perl-perl| perlcritic..........................|ale-perl-perlcritic| php...................................|ale-php-options| + hack................................|ale-php-hack| + langserver..........................|ale-php-langserver| phpcs...............................|ale-php-phpcs| phpmd...............................|ale-php-phpmd| phpstan.............................|ale-php-phpstan| @@ -204,7 +206,7 @@ The following languages and tools are supported. * Objective-C++: 'clang' * OCaml: 'merlin' (see |ale-linter-integration-ocaml-merlin|) * Perl: 'perl' (-c flag), 'perlcritic' -* PHP: 'hack', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan' +* PHP: 'hack', 'langserver', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan' * Pod: 'proselint' * Pug: 'pug-lint' * Puppet: 'puppet', 'puppet-lint'