表記ゆれを nvcheck で自動的に検出する

表記揺れチェッカには何種類かありますが、筆者は nvcheck を使っています。本稿では nvcheck の使い方についてまとめます。

https://github.com/koron/nvcheck/blob/master/README.md にある README にも記されていますが、ここでも使い方をまとめておきます。

まず公式サイトにあるように Go言語の環境を構築します。

次に、nvcheck をインストールします。

$ cd $(mktemp -d); GO111MODULE=on go get github.com/koron/nvcheck

なお Go 1.16 以降では

$ go install github.com/koron/nvcheck@latest

とするようです*1。

すると

$ go env GOBIN

に記された場所に nvcheck コマンドが追加されます。

対象にしたいテキストファイル file.txt があるディレクトリに dict.yaml を置きます:


正しい表記:
  - 誤りの表記1
  - 誤りの表記2
# コメント

したがう:
  - 従う
したがって:
  - 従って

file.txt をチェックしたいときは:

$ nvcheck file.txt

これを Makefile か何かに書いておくと Vim の quickfix 機能で確認できます。

また、次のようにすると file.txt が自動的に修正され、標準出力に出力されます。

$ nvcheck -r file.txt

さらに、-i オプションを使うとfile.txt 自体を自動的に修正できますが、バグがあった際にデータが消失する可能性があります。

$ nvcheck -i file.txt