CJK文字列を検知するツールを作った

ふだん開発を行う中で、コード中のコメントなどを英語オンリーに縛りたい場合があると思います。そうしたとき、CJK文字列を検知するツールがあれば、英語オンリーで開発をしていることが担保できますよね、、、ということで、作りました。

https://github.com/aethiopicuschan/nocjk

これはCLIツールとして動作するので、pre-commitのフックなどに使えます。また、GitHub Actionを予め提供しているので、CIへの導入も簡単です。

オプションとして、以下の3つを用意しています。

• --ignore-chinese
• --ignore-japanese
• --ignore-korean

特定の言語を無視したい場合に指定できます。

また、.nocjkignore というファイルを設置することで、指定されたファイルに対する検知を無視できます。これは .gitignore と同じ挙動をするので、理解しやすいかと思います。

合わせておまけ的な要素ですが、このツールはGolangのライブラリとしても利用することが可能です。詳しくはリファレンスをご覧ください。

以上です。あまり需要があるわけではなさそうですが、誰かのためになれば幸いです。