summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-06-13 17:59:09 +0100
committerw0rp <devw0rp@gmail.com>2017-06-13 17:59:09 +0100
commitba83c476cde8bceef33bf959fa6d9d3334f5d2fc (patch)
treef0cc8ef137b73b1af75126bc87e4430a959a3807
parentebbfb642211d9a8199e9b1da0c8f3077f953a2c9 (diff)
downloadale-ba83c476cde8bceef33bf959fa6d9d3334f5d2fc.zip
Document the tsserver linter
-rw-r--r--README.md2
-rw-r--r--doc/ale-typescript.txt35
-rw-r--r--doc/ale.txt3
3 files changed, 38 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5aa4ff87..8543129b 100644
--- a/README.md
+++ b/README.md
@@ -116,7 +116,7 @@ name. That seems to be the fairest way to arrange this table.
| Swift | [swiftlint](https://swift.org/) |
| Texinfo | [proselint](http://proselint.com/)|
| Text^ | [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) |
-| TypeScript | [tslint](https://github.com/palantir/tslint), typecheck |
+| TypeScript | [tslint](https://github.com/palantir/tslint), tsserver, typecheck |
| Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) |
| Vim | [vint](https://github.com/Kuniwak/vint) |
| Vim help^ | [proselint](http://proselint.com/)|
diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt
index ca156320..a1f5aafc 100644
--- a/doc/ale-typescript.txt
+++ b/doc/ale-typescript.txt
@@ -38,4 +38,39 @@ g:ale_typescript_tslint_use_global *g:ale_typescript_tslint_use_global*
-------------------------------------------------------------------------------
+tsserver *ale-typescript-tsserver*
+
+g:ale_typescript_tsserver_executable *g:ale_typescript_tsserver_executable*
+ *b:ale_typescript_tsserver_executable*
+ Type: |String|
+ Default: `'tsserver'`
+
+ ALE will first discover the tsserver path in an ancestor node_modules
+ directory. If no such path exists, this variable will be used instead.
+
+ If you wish to use only a globally installed version of tsserver, set
+ |g:ale_typescript_tsserver_use_global| to `1`.
+
+
+g:ale_typescript_tsserver_config_path *g:ale_typescript_tsserver_config_path*
+ *b:ale_typescript_tsserver_config_path*
+ Type: |String|
+ Default: `''`
+
+ ALE will first discover the tsserver.json path in an ancestor directory. If
+ no such path exists, this variable will be used instead.
+
+
+g:ale_typescript_tsserver_use_global *g:ale_typescript_tsserver_use_global*
+ *b:ale_typescript_tsserver_use_global*
+ Type: |Number|
+ Default: `0`
+
+ This variable controls whether or not ALE will search for a local path for
+ tsserver first. If this variable is set to `1`, then ALE will always use the
+ global version of tsserver, in preference to locally installed versions of
+ tsserver in node_modules.
+
+
+-------------------------------------------------------------------------------
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 4159986c..6edd3f74 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -91,6 +91,7 @@ CONTENTS *ale-contents*
lacheck.............................|ale-tex-lacheck|
typescript............................|ale-typescript-options|
tslint..............................|ale-typescript-tslint|
+ tsserver............................|ale-typescript-tsserver|
vim...................................|ale-vim-options|
vint................................|ale-vim-vint|
xml...................................|ale-xml-options|
@@ -188,7 +189,7 @@ The following languages and tools are supported.
* Swift: 'swiftlint'
* Texinfo: 'proselint'
* Text: 'proselint', 'vale'
-* TypeScript: 'tslint', 'typecheck'
+* TypeScript: 'tslint', 'tsserver', 'typecheck'
* Verilog: 'iverilog', 'verilator'
* Vim: 'vint'
* Vim help: 'proselint'