JP Proofreader
GitHub Copilot を使って日本語テキストをその場で校閲する VS Code 拡張機能です。文法チェック、表現改善、誤字脱字の検出、商標・差別表現の確認など、7つの観点から構造化されたフィードバックを提供します。
機能
- AIレビュー — テキストを入力してボタンを押すだけで、GitHub Copilot が校閲結果をストリーミング表示します。
- 構造化フィードバック — 校閲結果を以下の7観点のアコーディオンに整理して表示します。
- 誤字・脱字
- 文法・表現
- 冗長さ
- 内容の明確さ
- 商標の侵害
- セキュリティ的な問題
- 差別表現
- 校閲アウトライン — サイドバーの「校閲アウトライン」ツリーに観点ごとにグループ化された指摘一覧を表示します。ツリー項目をクリックすると、エディタの該当箇所にジャンプします。
- エディタ診断 — 校閲結果をもとに、アクティブなエディタの該当箇所にウェーブアンダーラインを表示します(
error → 赤、suggestion → 黄、ok → 青)。
- クイックフィックス — 修正案がある指摘箇所では「修正を適用」コードアクションが提示され、ワンクリックで修正を適用できます。
- URLからテキストを読み込む — URLを入力すると、そのページの本文テキストを自動取得して校閲対象に設定します。
- システムプロンプトのカスタマイズ — 設定タブからプロンプトを編集し、校閲の観点や文体を調整できます。プロンプトはファイルへの保存・ファイルからの読み込みにも対応しています。
- プロジェクト固有ルール エディタ — サイドバーの「プロジェクト固有ルール」パネルにある専用テキストエリアで用語集・カスタムルールを編集できます。変更は
vscode-jp-proofreader.customRules 設定に自動保存され、校閲時に最優先で適用されます。ワークスペースルートに .proofreaderrc.txt または proofreader-dict.txt を置く方法もサポートしており、設定が空の場合のフォールバックとして機能します。
- Copilot チャット参加者 (
@proofreader) — GitHub Copilot のチャットから直接 @proofreader <テキスト> で校閲を依頼できます。
必要要件
使い方
パネルを開く
アクティビティバーの JP Proofreader アイコンをクリックし、「JP Proofreaderを開く」ボタンを押すか、コマンドパレット (Ctrl+Shift+P) から JP Proofreader: Check を実行します。
テキストを校閲する
- 左ペインに校閲したいテキストを入力します(またはURLを入力して「読み込み」ボタンでページ本文を取得します)。
- 使用するモデルをドロップダウンから選択します。
- Copilotレビュー ボタンをクリックします。
- 右ペインに結果が表示されます。観点ごとのアコーディオンをクリックすると詳細を確認できます。
- 🟢 緑 (
ok) — 問題なし
- 🟠 オレンジ (
suggestion) — 改善提案
- 🔴 赤 (
error) — 要修正
システムプロンプトをカスタマイズする
「設定」タブを開き、システムプロンプトを編集して「保存」ボタンを押します。「デフォルトに戻す」でリセットできます。
設定
| 設定キー |
型 |
デフォルト |
説明 |
jp-proofreader.enableLogs |
boolean |
false |
デバッグ用の詳細ログをアウトプットチャンネルに出力します |
vscode-jp-proofreader.allowedModelPatterns |
array |
["gpt-4o","gpt-4","sonnet","opus","pro","o1","o3"] |
校閲に使用を許可するモデルを識別するための正規表現パターン一覧(大文字小文字を区別しない)。除外リストに該当しないモデルのうち、このリストのいずれかにマッチするモデルが選択候補として表示されます |
vscode-jp-proofreader.excludedModelPatterns |
array |
["mini","flash","haiku","nano"] |
校閲への使用から除外するモデルを識別するための正規表現パターン一覧(大文字小文字を区別しない)。このリストにマッチするモデルは許可リストの設定にかかわらず表示されません |
vscode-jp-proofreader.customRules |
string |
"" |
プロジェクト固有の校閲ルールや用語集を指定します。サイドバーの「プロジェクト固有ルール」パネルからも編集できます。設定が空の場合はワークスペースルートの .proofreaderrc.txt または proofreader-dict.txt がフォールバックとして読み込まれます |
ライセンス
MIT
| |