技術文章の文章校正をtextlintとGitHub Actionsで快適にする

8月前半に社内で『テックブログの文章校正をCIで快適にする』というタイトルでLTをしました。もともとは技術同人誌を執筆する時に校正作業を自動化していたこともあり、ブログに応用した例の発表です。発表から２週間ほど経ってしまったので、忘れないようにセルフ文字起こしです。

文章校正で解決したいこと

まず自分なりに「なぜ文章校正をCIで実行させたかったか」をまとめます。ブログや技術同人誌のような外向けに文章の校正作業は、軽微な修正が繰り返して面倒です。たとえば以下の作業が面倒な校正作業です。

上記のように軽微で繰り返し発生する作業は人間がやることじゃないですね。なるべく執筆に専念したいところです。これが文章校正CIを作りたかったモチベーションです。

上記の文章校正をCIに組み込める最適なツールがtextlintです。

textlintはテキストファイルとMarkdown文章に対して、事前定義したルールに違反する文章を検出する校正ツールです。 Node.jsのパッケージで提供されているので、プログラムから起動するのに適しています。また、公開されている校正ルールを複数取り込むことで細かい校正ルールを自分で作れます。

今回はtextlintと、私が技術同人誌2冊とブログ執筆で使っている以下の校正ルールを組み合わせます。

textlint-ja/textlint-rule-preset-ja-technical-writing
- 日本語の技術文書を書くためのtextlintのrule-preset
- e.g. 一文は100文字以下、二重否定は使用しない、半角カナを使わせない、など。
textlint-rule/textlint-rule-prh
- 表記ゆれに強い文章校正ツールprh (proofreading helper)を組み合わせたルールです。
- textlintと組み合わせて細かい校正ルールを適用できます。

textlintをCIへ組み込む前に、ローカルマシン上でtextlintを実行して文章校正してみます。事前にNode.jsをインストールします。

textlint実行の下準備は以下3ステップになります。

npmでtextlintとルールをインストールします。
お好きな校正ルールをダウンロードして配置します。
- 私はWEB+DB PRESSの校正ルールを使用しました。GitHub上のprh/rulesのリポジトリから取得します。
- https://github.com/prh/rules/blob/master/media/WEB%2BDB_PRESS.yml
.textlintrc に使用する校正ルールを定義します。
- 先にインストールしたルールをオプションとともにファイルに記述します。