Zenn
🤖

Visual Studio Code(VSCode)でファイル保存時にCopilotにReviewしてもらう

2024/12/30に公開
VS Code
Copilot
tech

やりたいこと

やり方

Run On Saveという拡張機能を使います。

  1. Run On Saveをインストール
  2. VSCodeの設定ファイル(settings.json)に以下の設定を追加
  3. ファイルを保存
    "runOnSave.statusMessageTimeout": 50000,
    "runOnSave.commands": [
        {
            // ここはレビュー対象にしたいファイルの拡張子を指定してください。ここではSQLファイルを対象にしています
            "match": "\\.(sql)$",
            "commandBeforeSaving": "editor.action.selectAll",
            "command": "github.copilot.chat.review",
            "runningStatusMessage": "Reviewieing ${fileBasename}",
            "runIn": "vscode"
        }
    ]

この設定では、

  1. 領域選択
    • ファイル単位でレビュー呼び出す方法がわからなかったため
  2. Copilot Reviewを呼び出す

を行っています。

動作確認

例としてSQLのレビューしてもらいます。.github/copilot-instructions.mdにレビュー観点を記載します（Custom Instructionsという機能）。

# SQLコードレビュー
* implicit aliasは使用せず、explicit aliasを使います。例えば"select 1 b"はダメで、"select 1 as b"である必要があります

適当なSQLファイルを保存します。

select 1 c

レビューが起動されました。

このレビューだけだったらSQLFluffなどのlinterで足りますが、少し凝ったレビュー観点も日本語で指示できるのが便利です。

注意

Run On Saveという拡張は

の同名の二つの拡張がありますが、pucelleさんの方を使うことに注意してください（emeraldwalkさんの方だとVSCode内のコマンドを呼び出す方法がわからなかったため）。

Discussion