Skip to content

テキストファイルやMarkdownファイルの日本語の文章をチェックするVS Codeの拡張機能

License

Notifications You must be signed in to change notification settings

ics-creative/project-japanese-proofreading

Repository files navigation

テキスト校正くん

VS Code上でテキストファイル・Markdownファイル・Re:VIEWファイルの日本語の文章をチェックする拡張機能です。該当のファイルを開いた時、更新した時に自動で校正のチェックを行い、文章内の問題のある箇所をマーキングし問題パネルにエラー内容を表示します。

メールの文章を作成する際やブログ記事の文章を作成する際などに、ご使用いただくと便利です。

デモ

ウェブ業界の専門用語を含め、一般的な文章のルールに沿って主に以下のようなチェックを行います。

  • 「ですます」調と「である」調の混在
    • 誤検出の回避のため「である調」の判定は明らかに常体な「〜である」のみとなっています。
  • ら抜き言葉
  • 二重否定
  • 同じ助詞の連続使用(※初期設定では無効)
  • 同じ接続詞の連続使用
  • 逆接の接続助詞「が」の連続使用
  • 全角と半角アルファベットの混在
  • 弱い日本語表現の利用(〜かもしれない)
  • 読点の数(1文に4つまで)
  • ウェブの用語や名称の表記統一(Javascript→JavaScript、Github→GitHub等)
  • 漢字の閉じ方、開き方(下さい→ください、出来る→できる等)

使い方

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

対応しているテキストファイルは以下の形式です。

  • テキストファイル(.txt
  • Markdownファイル(.md
  • HTMLファイル(.html
  • Latexファイル(.tex
  • Re:VIEWファイル(.re

問題パネルには、指摘内容と該当箇所(何行目の何文字目で発生しているか)の情報が表示されます。指摘内容をダブルクリックすることで該当箇所へカーソルを移動できるため、そのまま修正が可能です。リアルタイムでチェックを行っているため、該当箇所の修正を行うと、エラーが消えます。

指摘される例文を次のリンクにまとめています。コピーして校正ルールの確認にご利用ください。

校正ルールの変更方法

設定画面より有効にする校正ルールを選択できます。Ctrl+,+,)で設定画面を開き、左側のサイドバーから「拡張機能」>「テキスト校正くん」を選択し、有効にする校正ルールを選択してください。

About

テキストファイルやMarkdownファイルの日本語の文章をチェックするVS Codeの拡張機能

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published