textlint/textlint：README に基づく導入ガイド

textlint/textlint の README はプロジェクトを「textlint is the pluggable linter for natural language text.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「textlint」には次の説明があります。> The pluggable linting tool for natural language.。これは範囲の説明であり、本番検証の結果ではありません。

README の「Features」にある内容から、用途が合うかを先に判断できます。Supports the use of custom formatters and formatter bundles formatter(reporter)。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。To use a rule, install a textlint rule via npm.。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「Quick Tour」など複数の箇所に分かれています。確認できる情報は次の通りです。For a quick tour of textlint, checkout our Getting Started guide :squirrel:。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 $ npm install textlint --save-dev 実行可能なコマンドがない場合は手順を作らず、「Website」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「Installation」にはYou can install the textlint command using npm:とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはIf you have installed textlint globally you must install each reference rule globally as well.ともあります。

制約も確認が必要です。現在の資料からは、textlint/textlint の互換表、性能基準、サービス保証、長期サポートを確認できません。README の記載は「If you're not sure what version of Node you're running, you can run node -v in your console to find out.」です。不明点は採用記録の検証項目として残し、断定に変えないでください。