textlint

textlint - pluggable linting tool for text and markdown

textlintの公式サイトというかオンラインデモページを作成しました。

上記ページにアクセスするとブラウザ上でtextlintを動かして試すことができます。

デフォルトだとtextlint-rule-rousseauやtextlint-rule-alexといった英語向けのルールが設定されていますが、npmモジュール名を指定すれば任意のルールも読み込めます。

例えば、textlint-rule-spellcheck-tech-wordと入れて”Add rule”するとこのルールが動的に追加できて試せます。 Browserify CDNで動的にビルドして読み込んでいるので、Browserifyでビルドできないルールは流石にブラウザ上では動かないです。 (後、形態素解析とかやってるルールはそもそものファイルサイズが大きいです)

このサイトはDeku v2互換のdeccaとReduxで作りました。

Deku v2は最小限のAPIでReduxと合わせて使いやすい作りなので、初めてReduxを触るときはReact(react-redux)と合わせて使うよりもシンプルで理解しやすいかもしれません。

最近のtextlintを3分で把握できるスライドも書いたので、どんな感じのものをかをぱっと知りたい方は見ると面白いかもしれません。

デザイン

logo

textlintのロゴやアイコンを@uetchyさんに作っていただきました。

ロゴやアイコンやバナーはCC0ライセンスで利用できるので自由にご利用ください。

このロゴやアイコンはIssueで話し合いながら作って頂いたのですが、その中のデザイン見本にウェブサイトがあったのでそれを元に実装した感じになっています。

サイトは説明文とオンラインデモしかないので、ドキュメントはあいかわらずリポジトリの中に入ったままです。

最近、Getting Started with textlintという最初にとりあえず動かすまでのチュートリアルを書いたので、textlintを使ってみたい人はこの辺から読むといいかもしれません。

またサクッとプロジェクトに導入したい場合はルールがある程度まとまったルールプリセットを使うと、手軽に日本語のLintを始めることができます。

他のtextlint関連記事は以下から探すことができます。