textlintを使ってみる

ツイート
2021年06月21日
2021年06月21日

経緯

ブログやドキュメントを頻繁に書くので、良い文章を書くために導入してみる。

インストール

bash
yarn add -D \ textlint \ textlint-rule-preset-ja-spacing \ textlint-rule-preset-ja-technical-writing \ textlint-rule-spellcheck-tech-word

.textlintrcの生成

bash
yarn textlint --init

textlintの実行

bash
yarn textlint ./public-docs/* yarn textlint ./public-docs/* --fix # 自動修正

表記揺れ

bash
touch prh.yml

textlintrcに追記する。

json
{ ... "spellcheck-tech-word": true, "prh": { "rulePaths": [ "./prh.yml" ] } } }

prh.yml

yml
version: 1 rules: - expected: Google specs: - from: google to: Google - expected: GitHub specs: - from: github to: GitHub

参考