https://ics.media/entry/220404/

ICS MEDIAでは読みやすい文章作りの取り組みとして、自社で公開しているVS Code拡張機能の「テキスト校正くん」を使用して文章校正を行っています。スタッフの校正ルールを統一して、一定の品質と読みやすさを確保することを心がけています。

「テキスト校正くん」は、文章校正エンジンにtextlintというNode.jsのパッケージを使用しています。textlintは設定した校正ルールにもとづいて文章校正を行えるので、プロジェクトに適切なルールを設定して文章校正ができます。以下の記事で、textlintの活用事例が紹介されています。企業がtextlintを導入し、文章品質を高めるワークフローとして活用されていることがうかがえます。

この記事ではtextlintの導入手順と、ルールセットの管理・実行方法について紹介します。

textlintとは？

textlintとはLintと呼ばれる静的解析ツールで、テキストファイル（.txt）やMarkdownファイル（.md）等を対象に、校正ルールにもとづいて文章校正を行うツールです。校正ルールの自作や、提供されているルールを組み合わせて独自のルールセットを作成できます。

textlintは本体と校正ルールのセットで構成されています。校正ルールは日本語に限らず、ほかの自然言語でも多くのルールが提供されています。

導入手順

プロジェクトにtextlintと日本語の校正ルールをインストールする手順を紹介します。

紹介するサンプルは、以下のリポジトリから確認できます。不安な方はダウンロードして試してみてください。

※本記事ではNode.jsとnpmを利用します。Node.jsをインストールした状態で利用ください。

①プロジェクトのディレクトリでnpm initを実行し、npmの初期化処理を行います。

npm init --yes

②初期化後、textlintをインストールします。

npm install textlint

③使用したいルールも合わせてインストールします。