ページ数：180 無料サンプル版では、冒頭をご覧いただけます。「無料ダウンロード」ボタンからダウンロードください。
textlintとは
textlintはオープンソースの自然言語のlinterです。たとえば、「ですます」調で統一したい日本語の文章に対して「である」調が混ざった場合を機械的に検出できるため、わかりやすい文章を作る支援を受けられます。textlintの特徴としてpluggableであることが挙げられており、npm packageとして公開されているruleやpluginなどを利用することで機能を拡張できます。もし、既存のruleなどでは自分のやりたいことが実現できない場合でも、必要な機能を自作することで対応できる可能性があります。
本書の目的
本書はtextlintを使いこなせるようになることを目的としています。そのために、用語を解説するだけでなくtextlintのCLIで動作確認できるようになっており、手を動かしながら理解を深められるようになっています。最初はtextlintをインストールして自然言語に対してlintができることを確認することから始めます。その後、設定ファイルの記述やruleなどの用語の解説、CLIの使い方の詳細といったtextlintの利用に必要な知識を解説しています。さらに、既存のruleなどで解決できない場合に備え、TypeScriptを使ってruleなどを自作する方法まで解説します。またruleなどの自作では基本的に自動テストも実装するようになっているため、実践的な内容になっています。これによってtextlintの利用者としてだけでなく、必要に応じて拡張できるようになることを目指します。
対象読者
Node.jsやnpmなどのCLIツールの基本操作はできることを前提にしています。また、ruleなどを自作する方法の解説ではTypeScriptを使って実装していますが、TypeScriptの文法などは解説していません。その上で、次のような方を対象としています。 ・textlintを使ったことがなく、何ができるツールなのか知りたい ・文章のチェックを自動化したいが、何から始めればいいかわからない ・既存のruleなどでは物足りず、自分でruleなどを作れるようになりたい
サンプルコード
https://github.com/tomei-to-hinekure/supports-getting-started-with-textlint
目次
1章 textlintの概要 1.1 textlintを使ってみる 2章 設定ファイルの記述方法 2.1 設定ファイルの概要 2.2 ruleを設定する（rulesプロパティ） 2.3 fixable ruleを設定する（rulesプロパティ） 2.4 presetを設定する（rulesプロパティ） 2.5 filter ruleを設定する（filtersプロパティ） 2.6 pluginを設定する（pluginsプロパティ） 3章 textlintの利用方法 3.1 CLI 3.2 エディタと連携 3.3 MCPサーバ 4章 textlintをカスタマイズする 4.1 textlintの処理の全体像 4.2 TxtASTの概要 4.3 ruleの作り方 4.4 fixable ruleの作り方 4.5 presetの作り方 4.6 filter ruleの作り方 4.7 pluginの作り方 4.8 formatterの作り方
更新履歴
2026-11-21 ver1.0 ・初版