文章の校正チェックを自動で行うVisual Studio Codeの拡張機能「テキスト校正くん」を弊社からリリースしました。

短い文章であれば目視でもチェックできますが、長文になるとチェックに時間がかかり見落としも多くなってしまいます。また、いくら内容のいい文章を書いても誤字や脱字が多く体裁が整っていないと、印象が悪く読みづらい文章になってしまいます。

そんな時「テキスト校正くん」を利用することで、文章チェックの手間を軽減でき、文章の品質を高めることができます。

▲VS Codeの拡張機能「テキスト校正くん」

「テキスト校正くん」でできること

この拡張機能は、VS CodeでテキストファイルやMarkdownファイルの日本語の文章をチェックします。ファイルを開いた時、更新した時に自動で校正のチェックを行い、エディター内の該当箇所をマーキングし[問題]パネルに指摘内容を表示します。

一般的な文章のルールに沿って、主に以下のようなチェックを行います。

  • 「ですます」調と「である」調の混在
  • ら抜き言葉
  • 二重否定
  • 同じ助詞の連続使用
  • 同じ接続詞の連続使用
  • 逆接の接続助詞「が」の連続使用
  • 全角と半角アルファベットの混在
  • 弱い日本語表現の利用（〜かもしれない）
  • 読点の数（1文に3つまで）
  • ウェブの専門用語の表記統一（Javascript→JavaScript、Github→GitHub等）
  • 漢字の閉じ方、開き方（下さい→ください、出来る→できる等）

「テキスト校正くん」の利用シーン

クリエイターやエンジニアの方は文章を書く機会があまりないという方もいるかもしれません。しかし「テキスト校正くん」はVS Code上で手軽に利用できるため、以下のような場面でも活用できます。VS Code上で下書きを書いてもいいですし、気になる文章があった場合にその文章だけをテキストファイルにコピー&ペーストするだけで、すぐにチェックが可能です。

  • メール文章を書く時
  • ブログやQiitaなどに記事を投稿する時
  • 打ち合わせの議事録を書く時
  • 仕様書・設計書などのドキュメントを作成する時
  • 報告書や始末書を書く時

インストール方法

  1. Visual Studio Codeを起動し、サイドバーにある拡張機能のアイコンを選択します。もしくは、エディターのメニューより[表示] > [拡張機能]を選択し、拡張機能のパネルを表示します。

  1. 上部の入力ボックスに「テキスト」と入力すると拡張機能の一覧がフィルタリングされるので、一覧から「テキスト校正くん」を選択し、拡張機能をインストールします。

  1. インストールが完了したら、「再読み込み」ボタンが表示されるため、再読み込みボタンを押し再起動すればインストールは完了です。

利用方法

テキストファイル（.txt）またはMarkdownファイル（.md）を開くと自動で文章のチェックが行われ、[問題]パネルに指摘内容が表示されます。[問題]パネルが表示されていない場合は、ステータスバーの左下にあるアイコンをクリックし[問題]パネルを表示してください。

[問題]パネルには、指摘内容と該当箇所（何行目の何文字目で発生しているか）の情報が表示されます。指摘内容をダブルクリックすることで該当箇所へカーソルを移動できるため、そのまま修正が可能です。

校正のチェックはリアルタイムで行われているため、問題のある箇所を修正すると指摘内容が自動的に消えます。

拡張機能の開発について

VS Codeの拡張機能はJavaScriptで開発ができます。開発ドキュメントや開発環境を構築するコードジェネレーターなどが公式で用意されており、ウェブのフロントエンジニアの技術があれば手軽に開発できます。

「テキスト校正くん」のソースコードはMITライセンスで公開していますので、VS Codeの拡張機能の開発に興味がある方は参考ください。

文章構成のエンジンには、azu氏が開発しているtextlintというLintツールを利用しています。校正チェックのルールはJavaScriptで書くことができるため、独自のルールセットを作成することも、公開されているルールセットを適用することも可能です。

「テキスト構成くん」は、ウェブ業界の専門用語を含め一般的な文章校正ルールをあらかじめ拡張機能の内部に組み込んでいるため、ルールセットを作成する必要なく、拡張機能をインストールするだけですぐに利用できることが特徴です。

同じtextlintを利用したVS Codeの拡張機能「vscode-textlint」も公開されています。こちらの拡張機能は独自のルールセットを設定でき、利用者が自由にカスタマイズできるため、独自のルールセットを作成する知識のある方は、こちらを利用するとよいでしょう。

おわりに

誤字・脱字がなく体裁が整うだけで、印象が良くなりとても読みやすい文章になります。また、チェックにかかる時間を削減できるため、その時間を別の作業に当てることもできるでしょう。

「テキスト校正くん」はVS Codeの拡張機能であるため、特殊なツールを導入する必要もなく、環境構築の必要もなく無料で利用できます。簡単に導入できるため、試しに利用してみてはいかがでしょうか？