summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-08-07 13:08:51 +0100
committerw0rp <devw0rp@gmail.com>2017-08-07 13:08:51 +0100
commit39ebb431b6ebc2045c65fc0096ebee8a495478e0 (patch)
tree1a2a00a8dbb90c20cf73ea39a118d6b577e08062 /doc
parentf7d7abe5b2d97bc2ad46eca176f288209da7f23a (diff)
downloadale-39ebb431b6ebc2045c65fc0096ebee8a495478e0.zip
Document the PHP langserver integration
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-php.txt32
-rw-r--r--doc/ale.txt4
2 files changed, 35 insertions, 1 deletions
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
index 4109673a..c8874106 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -3,6 +3,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*
g:ale_php_phpcs_executable *g:ale_php_phpcs_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index 1c43910c..5eff73bb 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'