日本語記事にtextlintを実行する

08.05.2021 — Info, Tips, textlint, 日本語 — 1 min read

日本語コンテンツに対して textlint を実行するように設定した。

"textlint.configPath": ".textlintrc",
"textlint.targetPath": "content/**/*.ja.md",
"textlint.nodePath": "node_modules/.bin/textlint",

"lint-staged": {
  "*.{js,ts,tsx,css,md,mdx}": "prettier --write",
  "*.ja.md": "textlint"
}

textlint-rule-preset-ja-technical-writing を使用しているので、この行は注意されます！?

のようにエラーレベルの指摘（この場合感嘆符が文章に含まれている）があると、以下のようにコミットができない。 ¹

また、GH Action も追加しているので、husky が有効になっていない環境からコミットされてきた場合は CI 上で textlint が実行される想定。²

このファイルではスクリーンショットを取ったあとにコミットを成功させるために  で一時的に無効化している。 ↩
基本的には自分の環境からでは lint-staged の段階で弾かれるので、PR まで漕ぎ着けなくなる。 ↩

Footnotes