summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryasuhiroki <yasuhiroki.duck@gmail.com>2018-03-24 14:39:05 +0900
committeryasuhiroki <yasuhiroki.duck@gmail.com>2018-03-24 16:04:47 +0900
commit562862073fb5441590b5f3e5fabf9216a575a9fd (patch)
treeceb3e102c43945a1c91ca9fbb6540894dbcacc9c
parent1d33d2cacff9816ce487f9000675851041c25901 (diff)
downloadale-562862073fb5441590b5f3e5fabf9216a575a9fd.zip
Update document for textlint
-rw-r--r--README.md4
-rw-r--r--doc/ale-markdown.txt6
-rw-r--r--doc/ale-text.txt30
-rw-r--r--doc/ale.txt6
4 files changed, 42 insertions, 4 deletions
diff --git a/README.md b/README.md
index 6b422860..9c90e3b6 100644
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ formatting.
| Lua | [luac](https://www.lua.org/manual/5.1/luac.html), [luacheck](https://github.com/mpeterv/luacheck) |
| Mail | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) |
| Make | [checkmake](https://github.com/mrtazz/checkmake) |
-| Markdown | [alex](https://github.com/wooorm/alex) !!, [markdownlint](https://github.com/DavidAnson/markdownlint) !!, [mdl](https://github.com/mivok/markdownlint), [prettier](https://github.com/prettier/prettier), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) , [textlint](https://textlint.github.io/)|
+| Markdown | [alex](https://github.com/wooorm/alex) !!, [markdownlint](https://github.com/DavidAnson/markdownlint) !!, [mdl](https://github.com/mivok/markdownlint), [prettier](https://github.com/prettier/prettier), [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [remark-lint](https://github.com/wooorm/remark-lint) !!, [textlint](https://textlint.github.io/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) |
| MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) |
| Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! |
| nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) |
@@ -158,7 +158,7 @@ formatting.
| Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! |
| Terraform | [tflint](https://github.com/wata727/tflint) |
| Texinfo | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)|
-| Text^ | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good), [redpen](http://redpen.cc/) |
+| Text^ | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [redpen](http://redpen.cc/), [textlint](https://textlint.github.io/), [vale](https://github.com/ValeLint/vale), [write-good](https://github.com/btford/write-good) |
| Thrift | [thrift](http://thrift.apache.org/) |
| TypeScript | [eslint](http://eslint.org/), [prettier](https://github.com/prettier/prettier), [tslint](https://github.com/palantir/tslint), tsserver, typecheck |
| Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) |
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`