マニュアルの校正作業ツライのでVSCodeにtextlint入れた - 文章推敲ツール色々

Last updated at 2022-02-05Posted at 2020-12-17

textlint物語

上記に倣う記録。そのままですが、なぐり書き。書くのは好きだけど人の書いたものの読むだけってツライ、と思ったので入れたVSCodeとtextlint。

npm install -global textlint textlint-rule-preset-ja-technical-writing textlint-filter-rule-comments textlint-filter-rule-whitelist

打てばOK。色々ぶっ壊すと嫌なので階層を作って

C:\workspaces\textlint

main.md を配置

C:\workspaces\textlint>textlint --init
.textlintrc is created.

.textlintrc を以下のように編集

.textlintrc

{
  "filters": {
      "comments": true
  },
    "rules": {
        "preset-ja-technical-writing": true
    }
}

textlint main.md と打ってみると、コマンド上でもエラーが見られます。

あとは、VSCode 上から textlint のチェックを実行するために拡張機能をインストールします。
vscode-textlint - Visual Studio Marketplace

インストール後 VSCode を再起動し、作成したプロジェクトを開くことで textlint が有効になります。

目視の助けくらいにはなるかも。

同様、日本語を構成してくれるVSCode拡張

こんな感じのことを指摘してくれる。

中身的にはtextlintらしいので、textlintを自分でカスタマイズしていくか、うまく選択すると良さそう。

折角なので以下ツールについても書いておく。
JTF日本語標準スタイルガイドは、実務翻訳において和訳時に使用できる日本語表記ガイドライン。
またスタイルガイドとしてはGoogle社、マイクロソフト社のものが圧巻。

textlintはMarkdownなどテキスト向けのLintツール（元の意味は主にC言語のソースコードに対し、コンパイラよりも詳細かつ厳密なチェックを行うプログラム）。

仕様書・設計書・提案書・メール・障害票に「各ドキュメント共通してありがちなアンチパターン」。

以上お役に立てばさいわいです。