textlintを使った文章の楽な校正方法
概要
簡易的なものですが、textlintを使ってブログ記事の校正をする方法を紹介します。
文章の校正について
ブログなど、たくさんの方の目に入るような文章は、なるべくならば間違いの無い文章としたいと考えている人は多いのではないでしょうか。
私自身、ブログなどの記事は、誤字脱字のない、ちゃんとした文章を書きたいと思っています。
しかし、このような間違いの無い文章にするための校正作業は正直に言って難しかったり、見落としがあったりすることがあります。
そこで、できるならばコンピューターなどを用いて機械的に校正ができれば嬉しいところです。
色々と調べてみると、textlintというツールを使うことで、機械的に文章の校正ができることが分かりました。もちろん、textlintにも限度があるようで、言葉の誤用など複雑なことはできないようです。あくまでも、簡単な文法的な誤りやら抜き言葉、句読点の有無や量、文章の長さなどを指摘してくれるようです。
textlintの導入
ここからは、現在の私がtextlintを使って校正をする環境を作るまでを説明します。
textlintは、実行環境としてNode.jsを使うため、Node.jsを最初にインストールしておく必要があります。Node.jsのインストール方法は様々あるため、ここでは詳しく説明しませんが、ひとつの方法として、公式に公開されているインストーラーを使って、インストールする方法があります。
Node.jsのインストールを終えたら、textlintのインストールへと進んでいきます。textlintのインストール前に、Node.jsを利用するプロジェクトを作っておきます。なぜプロジェクトを作るのかというと、textlintやそれに付随するライブラリなどを管理しやすいようにするためです。
プロジェクトの作成は、ターミナルから行います。WindowsではコマンドプロンプトまたはPowerShell、macOSでは、ターミナル.appを起動します。その後、プロジェクトを作成したいフォルダやディレクトリまで移動して、次のコマンドを実行します。実行後は指示に従ってプロジェクトを作成します。
npm init .
次に、textlintとそれに関連して校正の設定のプリセットをインストールします。ちなみに、textlintは細かく設定できるのですが、設定できる項目や基本的に設定した方がよい項目はたくさんあります。そのため、それらの設定を簡単にできるプリセットを利用しています。
今回はテクニカルライティングのためのものと、日本語の文章における空白を適切に扱うためのものをインストールします。
npm install textlint textlint-rule-preset-ja-technical-writing textlint-rule-preset-ja-spacing
さらに、校正の設定として、プロジェクト内に.textlintrcを作成します。内容は次のようにします。
{
"filters": {},
"rules": {
"preset-ja-spacing": true,
"preset-ja-technical-writing": true
}
}
これでtextlintの導入は終わりです。
textlintの実行
textlintの設定を終えたので、校正する方法について説明します。校正をするときは、何らかのテキストファイルなどに文章を書いておきます。例えば私であれば、ブログシステムとしてWordPressを利用しているので、記事のプレビューページから記事の文章をコピペして、テキストファイルに起こしています。
このようなテキストファイルをあらかじめ用意しておいたら、プロジェクトのあるディレクトリで次のコマンドを実行します。
npx textlint text.txt
実行すると、次のような出力となります。
1:2 error 文末が"。"で終わっていません。 ja-technical-writing/ja-no-mixed-period
4:14 error 文末が"。"で終わっていません。 ja-technical-writing/ja-no-mixed-period
7:171 error 一文に二回以上利用されている助詞 "に" がみつかりました。 ja-technical-writing/no-doubled-joshi
9:43 error 一文に二回以上利用されている助詞 "が" がみつかりました。 ja-technical-writing/no-doubled-joshi
13:10 error 文末が"。"で終わっていません。 ja-technical-writing/ja-no-mixed-period
34:4 error 文末が"。"で終わっていません。 ja-technical-writing/ja-no-mixed-period
✖ 6 problems (6 errors, 0 warnings)
エラーとして、修正した方がよい箇所が示されています。先頭には修正するべき文章が含まれる行数が書かれているので、比較的探しやすいかと思います。
これらの情報を元に、満足できるところまで、修正して再度コマンドを実行して校正結果を確認を繰り返します。
さいごに
Node.jsのプロジェクトを毎回作るのは面倒ですので、一度作っておいたら、テキストファイルだけ書き換えて使い回しするというのが良いと思います。
また、今回は「textlint-rule-preset-ja-technical-writing」と「textlint-rule-preset-ja-spacing」というtextlintのプリセットを利用して校正の設定をしましたが、その他にもたくさんのプリセットがあります。例えば、テクニカルライティング用ではなく通常の文章用に「textlint-rule-preset-japanese」などを利用しても良いです。
実際にやってみて思ったこととして、完璧な校正をする場合はやはり人が見て作業する必要がありますが、簡易的なものでよければtextlintを使う方法が手軽で良さそうでした。少し導入が面倒ですが、是非この記事などを参考に利用してみてください。