📝

textlintによる校正

2021/10/18に公開約1,100字

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

https://textlint.github.io

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

  • 文の長さ
  • 表記の揺れ
  • 二重否定
  • etc...

詳しくはこちら

https://qiita.com/azu/items/60764ed6f415d3c748bf

基本的な使い方

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

今回はこちらのルールプリセットを使ってみます

https://github.com/kufu/textlint-rule-preset-smarthr

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やブラウザ拡張で使う方法もあります

https://qiita.com/azu/items/2c565a38df5ed4c9f4e1
https://gigazine.net/news/20210625-textlint-12/

参考資料

https://efcl.info/2015/09/10/introduce-textlint/
https://efcl.info/2015/12/30/textlint-preset/
https://efcl.info/2016/07/13/textlint-rule-preset-ja-technical-writing/
https://shanaiho.smarthr.co.jp/n/n881866630eda

Discussion

ログインするとコメントできます