textlintのウェブサイトをリニューアルして、ドキュメントもウェブサイトで見られるようにしました。

以前はデモ的なものが置いてあるだけでしたが、今回はDocusaurusを使ってドキュメントもウェブサイト上で見たり、検索できるようになっています。

DocSearchを使った全文検索も入っているのでリポジトリを直接見るよりは探しやすいと思います。

また、textlintをプロジェクトや会社で使ってる人はUsersページにアイコンを追加できます。

textlint users

https://github.com/textlint/textlint/edit/master/website/siteConfig.jsのusersという変数にロゴやURLを追加するPull Requestを出すだけです。

是非Pull Requestを出してみてください！

textlintについて

ウェブサイトも新しくなったのでこれからもドキュメント面などを充実させていきたいです。 特にルールの作り方周りについてはnpm init/yarn createの対応などもっと分かりやすく作りやすくしたいです。

textlint-filter-rule-whitelistとルール独自のallowオプションによる正規表現の違いに注意する - Qiitaでも話されていましたが、ルールによってオプションやドキュメントのバラ付きがあるのもどうにかしていきたいです。(リポジトリが分かれているのでどうしてもばらつきが出てくる。今回は@textlint/regexp-string-matcherというライブラリを作って動作を統一していく)

また、ルールのメッセージも完全に自由なので、i18n対応なども見据えてある種のパターンを作るなどして、利用者からみてより分かりやすくしていきたいです。

興味がある人はIssues · textlint/textlintなどを見てください。 Pull RequestやIssueはいつでも歓迎しています。

実際ウェブサイトのリニューアルはコントリビュータの協力がありできました。

  • @0x6b start to work migrate exising document to website.
  • @uetchy design this website.
  • @azu implement the design and deploy.

ルール関係

ニューラルネットワークを用いた日本語学習者の文章における不自然箇所検知(via 最終論文集)でもtextlintが引用されていましたが、そろそろクライアントサイドでも機械学習を使ったルールというものができてもおかしくはないんじゃないかなと思いました。

textlintが特徴的なのはソースが公開されていて、サーバにデータを送ることなくクライアント側で動作する点にあると思うので、その辺はもっと見ていきたいですね。

また、最近Proofdict · A dictionary engine that based on one rule per one file.という自分用辞書を作るというプロジェクトをやっていて、実際に自分で使っている分には問題ないので、もうそろそろしたら何か書こうと思います。

簡単に説明すると自分用の1ルール1ファイルの辞書をGitHubリポジトリをforkするだけでつくれて、ブラウザだけで更新できて、自動的にウェブAPIとして辞書が公開されて、作った辞書を使ってtextlintでチェックできるという感じのプロジェクトです。

イマイチ分かりやすさや目的が伝わらない感じがするので、Usage · Proofdictから試して感想とかくれると嬉しいです。