📝

textlintによる校正

2021/10/19に公開

textlintはnode.jsで書かれたテキストとMarkdownの校正ツールです

テクニカルライティングであげられる項目のうち、
自動でチェックできそうな部分を校正するためのものです

基本的な使い方

textlintはデフォルトでチェック用のルールを持っていないので、
公開されているルールプリセットをインストールして使います

npmでグローバルにtextlintとプリセットをインストール

$ npm install -g textlint textlint-rule-preset-smarthr

プリセットを指定して設定ファイルなしでコマンドラインから実行

$ textlint --preset preset-smarthr test.txt

.textlintrcファイルに設定を追加します（textlint --initで作成できる）
設定ファイルを使うと個別にON/OFFができます→詳細は上記リポジトリ等を参照

{
  "rules": {
    "preset-smarthr": true
  }
}

設定ファイルのあるディレクトリで実行

$ textlint test.txt

vscodeやブラウザ拡張で使う方法もあります