textlintで文章を校正する

textlintを使って、文章を校正するためのメモ。
このブログはAstroを使っていて、記事はMarkdownで書いているので相性が良い。

textlintのインストール

npm install --save-dev textlint

日本語用ルールの追加

npm install --save-dev textlint-rule-preset-japanese textlint-rule-preset-ja-technical-writing

含まれているルールはそれぞれのREADMEに書かれている。

その他のルール

  • textlint-rule-ng-word：NGワードをチェックする（企業ブログで、社内用語をNGにしておくと良さそう）
  • textlint-rule-terminology：用語の正しい表記をチェックする（Javascript → JavaScriptなど）
  • textlint-rule-date-weekday-mismatch：日付と曜日の不一致をチェックする
  • textlint-rule-no-todo：TODOが残っていないかチェックする
  • textlint-rule-abbr-within-parentheses：OSS（Open Source Software）→ Open Source Software(OSS)

textlintの初期化

npx textlint --init

.textlintrc.jsonが作成される。

textlintの実行

npx textlint src/content/blog/2023/09/23-textlint.md