ブログの校正にtextlintを導入した

2022-07-30

ブログ記事の校正のためtextlintを導入した。

環境

% node -v
v14.17.6
% npm -v
6.14.15

インストール

グローバルではなくプロジェクトで devDependencies を指定してインストール。

npm install --save-dev textlint

ルールの追加

次のルールを利用。

npm install --save-dev textlint-rule-preset-ja-technical-writing textlint-rule-preset-jtf-style

設定ファイルを作成し、ルールを有効にする。 .textlintrc を作成し、複数の拡張子を扱える。 今回はyamlで記述するため、 .textlintrc.yaml を追加。

rules:
  preset-jtf-style: true
  preset-ja-technical-writing: true

textlint-rule-preset-JTF-style

日本翻訳連盟(JTF)の日本語標準スタイルガイドを適用する。 句点 ・読点 、記号の半角・全角や全角と半角の間のスペースなどを構成できる。

textlint-rule-preset-ja-technical-writing

技術文書向けのプリセット。 一文字の長さからですます調、である調の統一や することができる どの冗長な表現を校正できる。

textlint-rule-spellcheck-tech-word

後述するProofdictに置き換えられるため、現在はメンテナンスされていない。

textlintの実行

対象のファイル、ディレクトリを指定実行する。

% npx textlint content/blog/textlint/index.md

/Users/kkenya/work/github.com/kkenya/blog/content/blog/textlint/index.md
    7:64   error    文末が"。"で終わっていません。                                                                               ja-technical-writing/ja-no-mixed-period
   21:46   error    文末が"。"で終わっていません。                                                                               ja-technical-writing/ja-no-mixed-period

ブログ記事はvscodeでマークダウンを記述するため、都度コマンドを実行せず、拡張機能をインストールし、エディタにエラーを表示する。

vscode editor textlint error

Proofdictによる表記揺れの校正

Proofdict

辞書の管理ツール。 JavaScript という単語を辞書に追加することで javascript , Java Script のような表記揺れを検知できる。 proofdict/proof-dictionaryをフォークしGitHub Pagesで公開することにより自分の辞書を作成し、公開された辞書にGUIで単語を設定、編集が可能。

Proofdictの利用

ドキュメントに従い設定する 今回はあらかじめ定義済みであるazuさんのazu.github.io/proof-dictionaryを利用させてもらった。

textlintから利用するためプラグインのインストール。

npm install --save-dev @proofdict/textlint-rule-proofdict

.textlintrc.yaml に利用する辞書を設定する。

textlint-rule-proofdictを利用することでproofdictの辞書を textlint から利用できる。

rules:
  # 省略...
  "@proofdict/proofdict":
    dictURL: "https://azu.github.io/proof-dictionary/"

参考


Web系ソフトウェアエンジニアの備忘録

Contact: 3982ne@gmail.com