diff --git a/content/post/NeovimでGithub Copilotを試す.md b/content/post/NeovimでGithub Copilotを試す.md new file mode 100644 index 0000000..6c3349b --- /dev/null +++ b/content/post/NeovimでGithub Copilotを試す.md @@ -0,0 +1,177 @@ +--- +title: "NeovimでGithub Copilotを試す" +date: 2024-09-30T20:55:09+09:00 +draft: true +tags: ['tech'] +--- + +LLMの技術的成果が日に日に突きつけられて喉元まで迫っているのを感じる今日この頃、さすがにろくに使いこなせないのでは困るためついにGithub Copilotを試すことにした。LLMを応用した検索エンジン（Perprexy）は以前から使っていたが、開発環境と密に統合されるとどんな恩恵が得られるのかはやはり気になるところである。 + +僕の開発環境はNeovimなのでそれにしたがってCopilotを設定していく。Github Copilotは最低月額10ドルからのサブスクサービスなのだが、契約完了時に送られてきたクイックガイドにNeovim向けのものがあったのには少々驚かせられた。大抵Vim向けの設定は各々が手弁当で勝手に生やしている印象が強かったからだ。なんならNeovimのプラグインも公式で用意されている。 + +だが、本稿ではあえて用いず有志がLuaで書き直したcopilot.luaの方を使う。公式のものと比べて処理の効率化が図られている。プラグインマネージャにはlazy.nvimを使うものとする。まずは下記の通りにプラグインを導入して起動時に読み込まれるように設定する。 + +```lua +---lazy +{ "zbirenbaum/copilot.lua", cmd = "Copilot" }, + +---copilot +require("copilot").setup({ + suggestion = { enabled = false }, + panel = { enabled = false }, +}) +``` + +上記の設定で`suggestion`がfalseな理由は標準とは異なる形でコード支援を受けるためだ。`true`にすると任意のキーでエディタ上にコードの予測が現れる。また、`auto_trigger`を項目に追加して`true`に設定すると自動的に表示されるようになる。しかし、本稿では補完プラグインのnvim-cmpと連携を行うため、これらは無効化しておく必要がある。 + +次に、一旦Copilotの認証を済ませる。プラグインが読み込まれた後に`:Copilot auth`を実行すると、時限制のトークンコードと共にGitHubの認証ページが案内される。自前で作成したファイルにsecretを格納する形式かと思っていたので、さすが今時は違うなと素直に感心した次第だ。 + +続いてnvim-cmpと連携を行う。標準設定ではエディタ上に薄くハイライトされるが、この設定では補完候補の一つとして表示される。個人的には、納得のいかないサジェストが前面にぶわっと出るよりも補完候補の一つに収まってくれる方が好ましいと感じる。nvim-cmp本体の詳細な設定は割愛させて頂く。 + +```lua +---lazy +{ "zbirenbaum/copilot-cmp", config = true, event = "InsertEnter" }, + + +---nvim-cmp +local cmp = require("cmp") + +--他の設定は省略 + +sources = cmp.config.sources({ + { name = "nvim_lsp", max_item_count = 15, keyword_length = 2 }, + { name = "vsnip", max_item_count = 15, keyword_length = 2 }, + { name = "copilot", max_item_count = 15, keyword_length = 2 }, -- copilotを補完ソースに追加する + { name = "nvim_lsp_signature_help" }, + { name = "buffer", max_item_count = 15, keyword_length = 2 }, +}), +}) + +local capabilities = require("cmp_nvim_lsp").default_capabilities() +``` + +`max_item_count`は補完候補の最大量で`keyword_length`は補完が発動する最小のキーワード数を意味する。デフォルト値で差し支えなければ削っても構わない。上記では他にも`sources`に補完ソースが記述されているが、どれも個別に設定していなければ動かない点に留意されたし。 + +```lua +local lspkind = require("lspkind") + +formatting = { + format = lspkind.cmp_format({ + mode = "symbol", + maxwidth = 50, + ellipsis_char = "...", + symbol_map = { Copilot = "" }, + }), +}, +``` + +lspkind.nvimを利用している場合は`formatting`に続く項目で補完候補のシンボルに任意の絵文字を配置できる。きれいな絵文字が並んでいるとモチベが上がるのでぜひ設定したい。なお、次候補の選択をTabキーで行っている人は以下の特殊な設定を追記する必要がある。 + +```lua +local has_words_before = function() + if vim.api.nvim_buf_get_option(0, "buftype") == "prompt" then + return false + end + local line, col = unpack(vim.api.nvim_win_get_cursor(0)) + return col ~= 0 and vim.api.nvim_buf_get_text(0, line - 1, 0, line - 1, col, {})[1]:match("^%s*$") == nil +end +cmp.setup({ + mapping = { + [""] = vim.schedule_wrap(function(fallback) + if cmp.visible() and has_words_before() then + cmp.select_next_item({ behavior = cmp.SelectBehavior.Select }) + else + fallback() + end + end), + }, +}) +``` + +以上の設定でGitHub Copilotの提案が補完候補の一部として表示されるようになる。 + +![](/img) + +さて、これでCopilotの設定は終わりかと思いきや、実はそうではない。LLMの最大と言っても過言ではない機能は対話による改善なので、チャットができないことには魅力半減だ。しかし公式のCopilot.vimにも今回紹介した非公式の方にもチャット機能は備わっていない。そこで、CopiotChat.nvimというさらに別のプラグインを導入する。 + +CopilotChat.nvimは名前通りCopilotとの対話機能を提供するプラグインである。数多くの連携プラグインが用意されており設定内容も多岐に渡るが、本稿では自由記述方式と、Telescopeと連携して定型文で質問を行う方法について記す。例によってTelescopeは導入済みとする。 + +```lua +---lazy +{ "CopilotC-Nvim/CopilotChat.nvim", build = "make tiktoken" }, + +--CopilotChat + +local select = require("CopilotChat.select") + +require("CopilotChat").setup({ + debug = true, + + window = { + layout = "float", + relative = "editor", + }, + prompts = { + Explain = { + prompt = "/COPILOT_EXPLAIN 選択されたコードの説明を段落をつけて書いてください。", + }, + Review = { + prompt = "/COPILOT_REVIEW 選択されたコードをレビューしてください。", + callback = function(response, source) end, + }, + Fix = { + prompt = "/COPILOT_FIX このコードには問題があります。バグを修正したコードに書き直してください。", + }, + Optimize = { + prompt = "/COPILOT_REFACTOR 選択されたコードを最適化してパフォーマンスと可読性を向上させてください。", + }, + Docs = { + prompt = "/COPILOT_DOCS 選択されたコードに対してドキュメンテーションコメントを追加してください。", + }, + Tests = { + prompt = "/COPILOT_TESTS 選択されたコードの詳細な単体テスト関数を書いてください。", + }, + FixDiagnostic = { + prompt = "ファイル内の次のような診断上の問題を解決してください:", + selection = select.diagnostics, + }, + }, +}) + +function CopilotChatBuffer() + local input = vim.fn.input("Quick Chat: ") + if input ~= "" then + require("CopilotChat").ask(input, { selection = require("CopilotChat.select").buffer }) + end +end + +vim.api.nvim_set_keymap("n", "9", "lua CopilotChatBuffer()", { noremap = true, silent = true }) + +function ShowCopilotChatActionPrompt() + local actions = require("CopilotChat.actions") + require("CopilotChat.integrations.telescope").pick(actions.prompt_actions()) +end + +vim.api.nvim_set_keymap( + "n", + "0", + "lua ShowCopilotChatActionPrompt()", + { noremap = true, silent = true } +) +``` + +上記のうち`prompts`に続く日本語文は、デフォルトでは英語で用意されている定型文を書き換えたものとなる。Copilot Chatは質問文と同じ言語で回答が返ってくるため、日本語で回答が欲しければ日本語で質問しなければならない。 + +![](/img/) + +`ShowCopilotChatActionPrompt`ではTelescopeを呼び出す関数が定義されている。この機能のなにが嬉しいのかというとコーディング中に頻繁に用いるであろう質問文をショートカットキーで即時に呼び出せるところだ。質問文が固定されていると回答も一意に定まりやすい。 + +他方、自由記述の入力は`CopilotChatBuffer`によって呼びされる。現在のバッファを対象に具体的な質問を行うことで、より高度な提案を引き出す効果が期待できる。ただし、Copilotはあくまでコーディング支援用のツールなので天気や時事問題、文章の校正などについて尋ねても回答は得られない。 + +![](/img/) + +たとえば、対応している質問を入力すると上記のような回答が得られる。期待以上に的を射た内容が多く、これがいつでも使えて月額10ドルなら十分割に合うと感じた。業務上のコードをむやみに読み取らせるのは下手をするとインシデントに発展しかねないが、工夫次第では活用できる見込みが高い。 + +ホビーユースにおいて成果物そのものが目的の場合には、質問とコピペを繰り返しながら制作するアプローチも今時は考えられるだろう。専門技術を積んでいない人でも個人の需要に即したものが手に入るのはまさしく科学の進歩だと言える。 + +あるいは勉強目的ですら、極めて短時間のうちに有機的なトライアンドエラーを繰り返せるという意味では、昔の写経プログラミングより効率的な学習効果が得られるかもしれない。いずれにしても、便利な道具の使い方を知っておいて損はない。 diff --git a/content/post/test.md b/content/post/test.md deleted file mode 100644 index c239767..0000000 --- a/content/post/test.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "NeovimでGithub Copilotを試す" -date: 2024-09-30T09:55:09+09:00 -draft: true -tags: ['tech'] ---- - -LLMの技術的成果が目に見えて我々に還元されるのを感じる今日この頃、さすがにろくに使い方も知らないのでは困るということでついにGithub Copilotを試すことにした。LLMを応用した検索エンジン（Perprexy）は以前から使っていたが、開発環境と密に統合されるとどう変化するのかは当然気になるところである。 - -さて、僕の開発環境はNeovimなのでそれにしたがってCopilotを設定していく。Github Copilotは最低月額10ドルからのサブスクサービスなのだが、契約完了時に送られてきたクイックガイドにNeovim向けのものがあったのには少々驚かせられた。大抵Vim向けの設定というのは各々が手弁当で勝手に生やす場合がほとんどだったからだ。なんならNeovimのプラグインも公式で用意されている。 - -だが、本稿ではあえてこれは使わず有志がLuaで書き直したcopilot.luaの方を用いる。公式のものと比べて処理の効率化が図られている。プラグインマネージャにはlazy.nvimを使うものとする。まずは下記の通りにプラグインを記述して起動時に読み込まれるように設定する。 - -```lua ----lazy -{ "zbirenbaum/copilot.lua", cmd = "Copilot" }, - ----copilot -require("copilot").setup({ - suggestion = { enabled = false }, - panel = { enabled = false }, -}) -``` - -上記の設定で`suggestion`がfalseになっている理由は標準とは異なる形でコード支援を受けるためだ。`true`にすると任意のキーでエディタ上にコードの予測が現れる。また、`auto_trigger`を項目に追加して`true`に設定すると自動的に表示される。しかし、本稿では補完プラグインであるnvim-cmpとの連携を行うため、これらは無効化しておく必要がある。 - -次に、一旦Copilotの認証を済ませる。プラグインが読み込まれた後に`:Copilot auth`を実行すると、時限制のトークンコードと共にGitHubの認証ページが案内される。ブラウザ上で認証を終えるとスムーズに連携が行われる。自前で作成したファイルにsecretを格納する形式かと思っていたので、さすが今時は違うなと素直に感心した次第だ。 - -続いてnvim-cmpと連携を行う。標準設定ではエディタ上に薄くハイライトされるが、この設定を通じて補完候補の一つとして表示されるようになる。個人的には納得のいかないサジェストが前面にぶわっと出るよりこっちの方が好ましいと感じている。nvim-cmp本体の設定はすでに実施されているものとして、本稿では割愛させて頂く。 - -```lua ----lazy -{ "zbirenbaum/copilot-cmp", config = true, event = "InsertEnter" }, - - ----nvim-cmp -local cmp = require("cmp") - ---他の設定は省略 - -sources = cmp.config.sources({ - { name = "nvim_lsp", max_item_count = 15, keyword_length = 2 }, - { name = "vsnip", max_item_count = 15, keyword_length = 2 }, - { name = "copilot", max_item_count = 15, keyword_length = 2 }, -- copilotを補完ソースに追加する - { name = "nvim_lsp_signature_help" }, - { name = "buffer", max_item_count = 15, keyword_length = 2 }, -}), -}) - -local capabilities = require("cmp_nvim_lsp").default_capabilities() -``` - -`max_item_count`は補完候補の最大量で`keyword_length`は補完が発動する最小のキーワード数を意味する。不要ならこの辺りは削っても構わない。lspkind.nvimを利用している場合は`formatting`に続く設定の形で補完候補のシンボルに任意の絵文字を設定できる。きれいな絵文字が並んでいるとモチベが上がるのでぜひ設定したい。 - -```lua -local lspkind = require("lspkind") - -formatting = { - format = lspkind.cmp_format({ - mode = "symbol", - maxwidth = 50, - ellipsis_char = "...", - symbol_map = { Copilot = "" }, - }), -}, -``` - -なお、次候補の選択をTabキーで行っている場合は以下の特殊な設定を追記する必要がある。 - -```lua -local has_words_before = function() - if vim.api.nvim_buf_get_option(0, "buftype") == "prompt" then - return false - end - local line, col = unpack(vim.api.nvim_win_get_cursor(0)) - return col ~= 0 and vim.api.nvim_buf_get_text(0, line - 1, 0, line - 1, col, {})[1]:match("^%s*$") == nil -end -cmp.setup({ - mapping = { - [""] = vim.schedule_wrap(function(fallback) - if cmp.visible() and has_words_before() then - cmp.select_next_item({ behavior = cmp.SelectBehavior.Select }) - else - fallback() - end - end), - }, -}) -``` - -以上の設定でGitHub Copilotの提案が補完候補の一部として表示されるようになる。 - -![](/img) - -さて、これでCopilotの設定は終わりかと思いきや、実はそうではない。LLMの最大と言ってもいい機能は対話による改善や、全体を俯瞰した効率的な提案なのでチャットができないことには魅力半減だ。しかし公式のCopilot.vimにも今回紹介した非公式の方にもそれは備わっていない。そこで、CopiotChat.nvimというさらに別のプラグインを導入する。 - -CopilotChat.nvimは名前通りCopilotとの対話機能を提供するプラグインである。多くの連携プラグインが用意されており、設定内容も多岐に渡るが本稿では現在のバッファの内容を考慮した上で質問する方法とTelescopeと連携して定型文の質問を行う方法の2種類について記す。Telescopeは導入済みとする。 - -```lua ----lazy -{ "CopilotC-Nvim/CopilotChat.nvim", build = "make tiktoken" }, - ---CopilotChat - -local select = require("CopilotChat.select") - -require("CopilotChat").setup({ - debug = true, - - window = { - layout = "float", - relative = "editor", - }, - prompts = { - Explain = { - prompt = "/COPILOT_EXPLAIN 選択されたコードの説明を段落をつけて書いてください。", - }, - Review = { - prompt = "/COPILOT_REVIEW 選択されたコードをレビューしてください。", - callback = function(response, source) end, - }, - Fix = { - prompt = "/COPILOT_FIX このコードには問題があります。バグを修正したコードに書き直してください。", - }, - Optimize = { - prompt = "/COPILOT_REFACTOR 選択されたコードを最適化してパフォーマンスと可読性を向上させてください。", - }, - Docs = { - prompt = "/COPILOT_DOCS 選択されたコードに対してドキュメンテーションコメントを追加してください。", - }, - Tests = { - prompt = "/COPILOT_TESTS 選択されたコードの詳細な単体テスト関数を書いてください。", - }, - FixDiagnostic = { - prompt = "ファイル内の次のような診断上の問題を解決してください:", - selection = select.diagnostics, - }, - }, -}) - -function CopilotChatBuffer() - local input = vim.fn.input("Quick Chat: ") - if input ~= "" then - require("CopilotChat").ask(input, { selection = require("CopilotChat.select").buffer }) - end -end - -vim.api.nvim_set_keymap("n", "9", "lua CopilotChatBuffer()", { noremap = true, silent = true }) - -function ShowCopilotChatActionPrompt() - local actions = require("CopilotChat.actions") - require("CopilotChat.integrations.telescope").pick(actions.prompt_actions()) -end - -vim.api.nvim_set_keymap( - "n", - "0", - "lua ShowCopilotChatActionPrompt()", - { noremap = true, silent = true } -) -``` - -上記のうち`prompts`に続く日本語は標準では英語で用意されている定型句の質問文を書き換えたものとなる。Copilot Chatは質問に用いた言語で回答が返ってくるため、あえて日本語を設定しなおした。英語で差し支えないならこの項目は丸ごとカットしても問題ない。また、`function ShowCopilotChatActionPrompt`でTelescopeを呼び出す関数を定義している。 - -![](/img/) - -この機能のなにが嬉しいのかというとコーディング中に頻繁に用いるであろう質問文をわずかなキータイプで入力できること、質問文が固定されているので精度の高い回答が期待できることなどが挙げられる。一方、自由記述の入力ウインドウは`function CopilotChatBuffer`によって呼びされる。 -