Update document for textlint

This commit is contained in:
yasuhiroki 2018-03-24 14:39:05 +09:00
parent 1d33d2cacf
commit 562862073f
4 changed files with 42 additions and 4 deletions

View File

@ -122,7 +122,7 @@ formatting.
| Lua | [luac](https://www.lua.org/manual/5.1/luac.html), [luacheck](https://github.com/mpeterv/luacheck) | | 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) | | Mail | [alex](https://github.com/wooorm/alex) !!, [proselint](http://proselint.com/), [vale](https://github.com/ValeLint/vale) |
| Make | [checkmake](https://github.com/mrtazz/checkmake) | | 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) | | MATLAB | [mlint](https://www.mathworks.com/help/matlab/ref/mlint.html) |
| Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! | | Nim | [nim check](https://nim-lang.org/docs/nimc.html) !! |
| nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) | | nix | [nix-instantiate](http://nixos.org/nix/manual/#sec-nix-instantiate) |
@ -158,7 +158,7 @@ formatting.
| Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! | | Tcl | [nagelfar](http://nagelfar.sourceforge.net) !! |
| Terraform | [tflint](https://github.com/wata727/tflint) | | 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)| | 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/) | | 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 | | 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) | | Verilog | [iverilog](https://github.com/steveicarus/iverilog), [verilator](http://www.veripool.org/projects/verilator/wiki/Intro) |

View File

@ -27,6 +27,12 @@ prettier *ale-markdown-prettier*
See |ale-javascript-prettier| for information about the available options. See |ale-javascript-prettier| for information about the available options.
===============================================================================
textlint *ale-markdown-textlint*
See |ale-text-textlint|
=============================================================================== ===============================================================================
write-good *ale-markdown-write-good* write-good *ale-markdown-write-good*

View File

@ -2,6 +2,36 @@
ALE Text Integration *ale-text-options* 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* write-good *ale-text-write-good*

View File

@ -139,6 +139,7 @@ CONTENTS *ale-contents*
markdown..............................|ale-markdown-options| markdown..............................|ale-markdown-options|
mdl.................................|ale-markdown-mdl| mdl.................................|ale-markdown-mdl|
prettier............................|ale-markdown-prettier| prettier............................|ale-markdown-prettier|
textlint............................|ale-markdown-textlint|
write-good..........................|ale-markdown-write-good| write-good..........................|ale-markdown-write-good|
nroff.................................|ale-nroff-options| nroff.................................|ale-nroff-options|
write-good..........................|ale-nroff-write-good| write-good..........................|ale-nroff-write-good|
@ -234,6 +235,7 @@ CONTENTS *ale-contents*
texinfo...............................|ale-texinfo-options| texinfo...............................|ale-texinfo-options|
write-good..........................|ale-texinfo-write-good| write-good..........................|ale-texinfo-write-good|
text..................................|ale-text-options| text..................................|ale-text-options|
textlint............................|ale-text-textlint|
write-good..........................|ale-text-write-good| write-good..........................|ale-text-write-good|
thrift................................|ale-thrift-options| thrift................................|ale-thrift-options|
thrift..............................|ale-thrift-thrift| thrift..............................|ale-thrift-thrift|
@ -346,7 +348,7 @@ Notes:
* Lua: `luac`, `luacheck` * Lua: `luac`, `luacheck`
* Mail: `alex`!!, `proselint`, `vale` * Mail: `alex`!!, `proselint`, `vale`
* Make: `checkmake` * 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` * MATLAB: `mlint`
* Nim: `nim check`!! * Nim: `nim check`!!
* nix: `nix-instantiate` * nix: `nix-instantiate`
@ -382,7 +384,7 @@ Notes:
* Tcl: `nagelfar`!! * Tcl: `nagelfar`!!
* Terraform: `tflint` * Terraform: `tflint`
* Texinfo: `alex`!!, `proselint`, `write-good` * Texinfo: `alex`!!, `proselint`, `write-good`
* Text^: `alex`!!, `proselint`, `vale`, `write-good`, `redpen` * Text^: `alex`!!, `proselint`, `redpen`, `textlint`, `vale`, `write-good`
* Thrift: `thrift` * Thrift: `thrift`
* TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck` * TypeScript: `eslint`, `prettier`, `tslint`, `tsserver`, `typecheck`
* Verilog: `iverilog`, `verilator` * Verilog: `iverilog`, `verilator`