💯

textlintを設定してノーコストで技術文書のクオリティを担保する

2023/01/18に公開約1,000字

TL;DR

壊れた日本語や typo, 表記揺れなどを自動で検出し、文書のクオリティを担保するために textlint の設定をした。特に固有名詞については表記揺れは普段から気を付けて目をならしておきたい(誤:github → 正:GitHub 等)。
Qiita の こちらの記事 に従っただけ。
実際にはノーコストというのは少し盛りすぎて、自動検出までは出来ても修正は手動で行わないといけないものもあるのでローコストというのが正しい。しかし表記揺れのチェックなどに気を遣わず文書の中身に集中できるので非常に有用であると考える。

具体的手順

  1. textlint やプリセットルールをインストールする
$ npm install --save-dev \
    textlint \
    textlint-rule-preset-ja-spacing \
    textlint-rule-preset-ja-technical-writing \
    textlint-rule-spellcheck-tech-word
  1. textlint のルールファイルを作成する
$ npx textlint --init
  1. ルールファイル(.textlintrc)を編集
.textlintrc
{
  "filters": {},
  "rules": {
    "preset-ja-spacing": true,
    "preset-ja-spacing": {
      "ja-space-between-half-and-full-width": {
            "space": "always"
        }
    },
    "preset-ja-technical-writing": true,
    "spellcheck-tech-word": true
  }
}
  1. 自動フォーマットの設定を入れる
    VS Code の設定で editor.formatOnSave が true になっていないのであれば true に変更しておく。そうすることでファイル保存時に自動修正可能な点については自動修正してくれる。
{
  "editor.formatOnSave": true
}

Discussion

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