summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-03-24 13:19:38 +0000
committerGitHub <noreply@github.com>2018-03-24 13:19:38 +0000
commitd14558da32dd3d776c298fea6456c92870b46d5d (patch)
treeceb3e102c43945a1c91ca9fbb6540894dbcacc9c /doc
parentdbf530e87fde81397712a85ed87b6a15131afd4c (diff)
parent562862073fb5441590b5f3e5fabf9216a575a9fd (diff)
downloadale-d14558da32dd3d776c298fea6456c92870b46d5d.zip
Merge pull request #1448 from yasuhiroki/support-textlint-plaintext
Support textlint for plaintext
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-markdown.txt6
-rw-r--r--doc/ale-text.txt30
-rw-r--r--doc/ale.txt6
3 files changed, 40 insertions, 2 deletions
diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt
index 9a5290b7..d7e50093 100644
--- a/doc/ale-markdown.txt
+++ b/doc/ale-markdown.txt
@@ -28,6 +28,12 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
+textlint *ale-markdown-textlint*
+
+See |ale-text-textlint|
+
+
+===============================================================================
write-good *ale-markdown-write-good*
See |ale-write-good-options|
diff --git a/doc/ale-text.txt b/doc/ale-text.txt
index a4dfa5e2..844f2ff4 100644
--- a/doc/ale-text.txt
+++ b/doc/ale-text.txt
@@ -3,6 +3,36 @@ ALE Text Integration *ale-text-options*
===============================================================================
+textlint *ale-text-textlint*
+
+The options for the textlint linter are global because it does not make
+sense to have them specified on a per-language basis.
+
+g:ale_textlint_executable *g:ale_textlint_executable*
+ *b:ale_textlint_executable*
+ Type: |String|
+ Default: `'textlint'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_textlint_options *g:ale_textlint_options*
+ *b:ale_textlint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to textlint.
+
+
+g:ale_textlint_use_global *g:ale_textlint_use_global*
+ *b:ale_textlint_use_global*
+ Type: |Number|
+ Default: `0`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
write-good *ale-text-write-good*
See |ale-write-good-options|
diff --git a/doc/ale.txt b/doc/ale.txt
index e99eaeba..c5b1c071 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -139,6 +139,7 @@ CONTENTS *ale-contents*
markdown..............................|ale-markdown-options|
mdl.................................|ale-markdown-mdl|
prettier............................|ale-markdown-prettier|
+ textlint............................|ale-markdown-textlint|
write-good..........................|ale-markdown-write-good|
nroff.................................|ale-nroff-options|
write-good..........................|ale-nroff-write-good|
@@ -234,6 +235,7 @@ CONTENTS *ale-contents*
texinfo...............................|ale-texinfo-options|
write-good..........................|ale-texinfo-write-good|
text..................................|ale-text-options|
+ textlint............................|ale-text-textlint|
write-good..........................|ale-text-write-good|
thrift................................|ale-thrift-options|
thrift..............................|ale-thrift-thrift|
@@ -346,7 +348,7 @@ Notes:
* Lua: `luac`, `luacheck`
* Mail: `alex`!!, `proselint`, `vale`
* Make: `checkmake`
-* Markdown: `alex`!!, `markdownlint`!!, `mdl`, `prettier`, `proselint`, `redpen`, `remark-lint`, `vale`, `write-good`, `textlint`
+* Markdown: `alex`!!, `markdownlint`!!, `mdl`, `prettier`, `proselint`, `redpen`, `remark-lint`, `textlint`, `vale`, `write-good`
* MATLAB: `mlint`
* Nim: `nim check`!!
* nix: `nix-instantiate`
@@ -382,7 +384,7 @@ Notes:
* Tcl: `nagelfar`!!
* Terraform: `tflint`
* Texinfo: `alex`!!, `proselint`, `write-good`
-* Text^: `alex`!!, `proselint`, `vale`, `write-good`, `redpen`
+* Text^: `alex`!!, `proselint`, `redpen`, `textlint`, `vale`, `write-good`
* Thrift: `thrift`
* TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck`
* Verilog: `iverilog`, `verilator`