NeovimでGitHub Copilot Chatを使う方法

概要

GitHub Copilot Chatは、開発者がコーディング中にリアルタイムで支援を受けることができるツールです。 copilot.vim を使えばNeovimでもGitHub Copilotは使えるのですが、まだChatには対応していません。 Neovimエディタで利用することで、コードの自動補完やドキュメントの参照、コーディングの疑問点を解決するための対話が可能になります。

CopilotChat.nvim を使うことでChatを利用できるようになります。

設定方法

1. プラグインをインストールする

まずプラグインをインストールする必要があります。お使いのプライグインマネージャーに応じて設定してください。自分の環境は vim-plug なので下記を追加しました。

1
2
3
4
5
6
7
8
9
call plug#begin()
Plug 'zbirenbaum/copilot.lua'
Plug 'nvim-lua/plenary.nvim'
Plug 'CopilotC-Nvim/CopilotChat.nvim', { 'branch': 'canary' }
call plug#end()

lua << EOF
require("CopilotChat").setup {}
EOF

その後、 :PackerSync コマンドを実行しインストール後にNeovimを再起動すると完了です。

2. GitHub Copilot Chatが日本語で回答するように設定する

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
lua << EOF
require("CopilotChat").setup({
    show_help = "yes",
    prompts = {
        Explain = {
          prompt = "/COPILOT_EXPLAIN アクティブな選択範囲の説明を段落形式で書いてください。日本語で返答ください。",
        },
        Review = {
          prompt = "/COPILOT_REVIEW 選択されたコードをレビューしてください。日本語で返答ください。",
        },
        FixCode = {
          prompt = "/COPILOT_GENERATE このコードには問題があります。バグを修正したコードに書き直してください。日本語で返答ください。",
        },
        Refactor = {
          prompt = "/COPILOT_GENERATE 明瞭性と可読性を向上させるために、次のコードをリファクタリングしてください。日本語で返答ください。",
        },
        BetterNamings = {
          prompt = "/COPILOT_GENERATE 選択されたコードの変数名や関数名を改善してください。日本語で返答ください。",
        },
        Documentation = {
          prompt = "/COPILOT_GENERATE 選択範囲にドキュメントコメントを追加してください。日本語で返答ください。",
        },
        Tests = {
          prompt = "/COPILOT_GENERATE コードのテストを生成してください。日本語で返答ください。",
        },
        Wording = {
          prompt = "/COPILOT_GENERATE 次のテキストの文法と表現を改善してください。日本語で返答ください。",
        },
        Summarize = {
          prompt = "/COPILOT_GENERATE 選択範囲の要約を書いてください。日本語で返答ください。",
        },
        Spelling = {
          prompt = "/COPILOT_GENERATE 次のテキストのスペルミスを修正してください。日本語で返答ください。",
        },
        FixDiagnostic = {
          prompt = "ファイル内の次の問題を支援してください:",
          selection = select.diagnostics,
        },
        Commit = {
          prompt = "変更のコミットメッセージをcommitizenの規約に従って日本語で書いてください。タイトルは最大50文字、メッセージは72文字で折り返してください。メッセージ全体をgitcommit言語のコードブロックで囲んでください。",
          selection = select.gitdiff,
        },
        CommitStaged = {
          prompt = "変更のコミットメッセージをcommitizenの規約に従って日本語で書いてください。タイトルは最大50文字、メッセージは72文字で折り返してください。メッセージ全体をgitcommit言語のコードブロックで囲んでください。",
          selection = function(source)
            local select = require("CopilotChat.select")
            return select.gitdiff(source, true)
          end,
        },
    },
})
EOF

COPILOT_EXPLAIN などはデフォルトでプロンプトの内容が定数化されています。(詳しくは、 prompts.lua を参照ください。) 続けて日本語で説明してもらうようにプロンプトを追加しています。

使い方

使い方はいろいろありますが、今回は、 :CopilotChatTests コマンドを使ってテストを作成してもらう方法を書きます。

対象となるコードをヤンクする
コマンドモードで :CopilotChatTests を入力するとChatが返ってくる
チャット画面で g + y をしてテストコードをヤンクする
テストファイルに p でペースト

で完成です。

まとめ

GitHub Copilot Chatは開発者にとって強力な支援ツールです。このツールを活用することで、開発の効率化とコーディングの質の向上が期待できます。

このポストは、NeovimでGitHub Copilot Chatを使う方法についての概要を提供しています。より詳細な情報やサポートが必要な場合は、公式ドキュメントやコミュニティフォーラムを参照してください。開発の旅において、GitHub Copilot Chatが有益なガイドとなることを願っています。