[[📒Articles]] > [[📒2025 Articles]] ![[2025-03-21.webp|cover-picture]] [[Neovim]]でAIコーディングをするためのプラグイン、[[CodeCompanion]]の設定方法や使い方をセットアップから順番に実例を交えてご紹介します。対象となるのは **『AIコーディングをはじめなければと思いつつも、[[Neovim]]以外のエディタには移行したくない...**』とお困りの開発者です。 > [!info] > - この記事は [[Vim駅伝]] #2025/03/21 の 参加記事です ## プロローグ ### 世はまさにAI時代 世はまさにAI一色の時代...。寝ても覚めても、仕事でもプライベートでも、リアルでもSNSでも、『**AI**という用語を見ない/聞かない日は1日たりともない』と言っても過言ではありません。その余波は我々[[Vimmer]]にも及びます。 --- **Aさん** 『わが社は本日より、[[VSCode]]と[[GitHub Copilot]]プラグインをルール化する！』 **Bさん** 『[[Cline]]や[[Roo Code]]に賭けなければ、この先は生き残れない..!!』 **Cさん** 『エンジニアの数を減らして[[Devin]]を投入だ！』 --- **『私はこれからも... [[Neovim]]が使いたいです...!!!!』** と言いにくい世界になってきました。 ### 一般論としてNeovimは圧倒的に不利 私が考える[[Neovim]]のメリットは以下3点です。 - **圧倒的スピード** - 私の[[Neovim]]起動速度は20ms前後です - **圧倒的カスタマイズ性** - 設定やプラグインで好みのエディタにカスタマイズできます - **[[ターミナル]]の中で完結する** - [[WSL]]の中でも、リモートでもどこでもサクっと使えます そんな[[Neovim]]にも弱点があります。 - **習得コストが非常に高い** - ほとんどの人が日常利用できるようになる前に挫折します - **UIの表現に限界がある** - [[Electron]]ベースのエディタみたいにWebブラウザ相当の表現は不可能です 前者は今更なのでどうということはありませんが、後者は結構なハンデです。というのも、昨今では[[AIエージェント]]を利用したフルスタックなAIコーディングがブームとなっており、UIの表現力がそのまま性能とUXに直結します。 ### その道は断たれた **わたし** 『AIなんか使わなくても、AIより速くモノがつくれればいいんでしょ？ [[Vimmer]]の俺に言わせれば、[[AIエージェント]]なんかと空中戦を繰り広げている間に、考えるよりも早く指が動いてモノができてしまうぜ。』 [[GPT-4o]]や[[o1]]、[[o3-mini]]、[[o3-mini-high]]、[[Claude 3.5 Sonnet]]が出ていた頃はまだそう思っていました。とは言っても試さずにいるのはよくないので、[[OpenAI API]]に課金したり、[[GitHub Copilot]]を契約して色々試していたりもしました。 <div class="link-card-v2"> <div class="link-card-v2-site"> <img class="link-card-v2-site-icon" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/favicon-64.png" /> <span class="link-card-v2-site-name">Minerva</span> </div> <div class="link-card-v2-title"> 📜2025-01-13 avante.nvimを使ってみる </div> <div class="link-card-v2-content">近年エディタのAI化が進む中、Neovimで話題のavante.nvimを導入し、OpenAI APIのGPT-4oモデルを用いて実用性や料金、導入手順、APIキー作成やエラー対応、実際のコード生成・編集体験を検証した。トークン消費やコストも具体的に試算し、Neovim環境でのAI活用の可能性を探った。</div> <img class="link-card-v2-image" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/Notes/attachments/activity.webp" /> <a data-href="📜2025-01-13 avante.nvimを使ってみる" class="internal-link"></a> </div> %%[[📜2025-01-13 avante.nvimを使ってみる]]%% <div class="link-card-v2"> <div class="link-card-v2-site"> <img class="link-card-v2-site-icon" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/favicon-64.png" /> <span class="link-card-v2-site-name">Minerva</span> </div> <div class="link-card-v2-title"> 📜2025-02-16 copilot.luaを使ってNeovimでGitHub Copilotを利用してみる </div> <div class="link-card-v2-content">VSCodeはUI面で優れているものの、できればNeovimでもGitHub Copilotを利用してみたい。copilot.vimとcopilot.luaのどちらがいいかを聞いてみたが、copilot.luaの方が良さそうとなった。</div> <img class="link-card-v2-image" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/Notes/attachments/activity.webp" /> <a data-href="📜2025-02-16 copilot.luaを使ってNeovimでGitHub Copilotを利用してみる" class="internal-link"></a> </div> %%[[📜2025-02-16 copilot.luaを使ってNeovimでGitHub Copilotを利用してみる]]%% このときはまだ、コード/文章のレビューに利用していた程度でした。[[VSCode Insiders]]をインストールして、Preview版のAgent modeも試しましたが、不安定で実用には程遠いという印象を受けただけです。([[Cline]]や[[Roo Code]]、[[Cursor]]は試していません) しかし、2月の終わりに[[Claude 3.7 Sonnet]]がリリースされ、その実力を目の当たりにしたとき私は悟りました。**もはや、私には選択権などない**ということに。 ### カイジ(本名:伊藤開司)に人生相談 それから1ヶ月弱、数年ぶりに設定を整備した[[VSCode]]と[[GitHub Copilot]]をできるだけ使ってきました。しかし、作業は捗りません。集中もできないし、何より開発作業に全く楽しめていない... むしろ苦痛を感じている自分と向き合う日々でした。 耐えられなくなった私はカイジ([[ChatGPT]])に相談してみました。 ![[Pasted image 20250316215015.png]] ![[Pasted image 20250316215038.png]] ![[Pasted image 20250316215102.png]] ![[Pasted image 20250316215144.png]] ![[Pasted image 20250316215207.png]] ![[2025-03-16_21h52_56.png]] **パワーワードきました** <span style="font-size: 1.8em; font-weight: bold">『なぁ...！！ お前のNeovimに聞いてみろよ！！』</span> おかげさまで、**[[Neovim]]と[[CodeCompanion]]で道を切り開く**決心がつきました。 ### なぜ [[CodeCompanion]] か？ 他にも選択肢はいくつかありましたが、以下の理由で[[CodeCompanion]]にしました。 - 仕様が[[Neovim]]をrespectしていると感じられ、使いやすい - 必要な機能は一通り揃っており、動作も比較的安定している - [[copilot.lua]]との相性も良さそう 次のセクションからは[[CodeCompanion]]の初期設定をしていきます。 ## 環境 | 対象 | バージョン | | ----------------- | ----------- | | [[Ubuntu]] | 24.04.1 LTS | | [[Neovim]] | 0.10.3 | | [[CodeCompanion]] | 14.0.0 | ## CodeCompanionのインストール それでは[[CodeCompanion]]をインストールしましょう。 <div class="link-card-v2"> <div class="link-card-v2-site"> <img class="link-card-v2-site-icon" src="https://github.githubassets.com/favicons/favicon.svg" /> <span class="link-card-v2-site-name">GitHub</span> </div> <div class="link-card-v2-title"> GitHub - olimorris/codecompanion.nvim: ✨ AI-powered coding, seamlessly in Neovim </div> <div class="link-card-v2-content"> ✨ AI-powered coding, seamlessly in Neovim. Contribute to olimorris/codecompanion.nvim development by creating an ... </div> <img class="link-card-v2-image" src="https://repository-images.githubusercontent.com/736363011/b616b58d-a118-463f-b99c-9f4a3532ef63" /> <a href="https://github.com/olimorris/codecompanion.nvim"></a> </div> [[lazy.nvim]]の場合、`./plugins/code-companion.lua` に設定します。 ```lua return { "olimorris/codecompanion.nvim", dependencies = { "nvim-lua/plenary.nvim", "nvim-treesitter/nvim-treesitter", }, opts = function(_, opts) -- 環境に依存しない設定 local base_opts = {} -- 環境ごとに切り分けたい設定 local env_opts = require("envs.code-companion").opts -- デフォルト設定 -> 環境に依存しない設定 -> 環境に依存する設定 の順にマージ return vim.tbl_deep_extend("force", opts, base_opts, env_opts) end, } ``` > [!attention] コードのパスについて > `./...` のような表記は `~/.config/nvim/lua` からの相対パスです。 環境に依存する設定として `./envs/code-companion.lua` を作成します。まずは `opts` があれば空で問題ありません。 ```lua return { opts = {}, } ``` > [!hint] > [[Neovim]]を利用するマシン環境が1つしかなければ [[vim.tbl_deep_extend]] を利用した設定のマージは不要です。ただ、私の環境では2つ以上を想定して設定しているため、その前提で進めさせてください。 [[Neovim]]を起動し、[[CodeCompanion]]がインストールされてから `:CodeCompanionChat` コマンドを実行して[[チャットバッファ (CodeCompanion)|チャットバッファ]]が開けばインストールは成功です。 ![[Pasted image 20250316224536.png|frame]] *右側が[[チャットバッファ (CodeCompanion)|チャットバッファ]]* ## チャットを使えるようにする まずは[[チャットバッファ (CodeCompanion)|チャットバッファ]]を使いこなせるようにします。 ### デバッグ情報の確認 [[チャットバッファ (CodeCompanion)|チャットバッファ]]の中で `gd` と押せばデバッグ情報が出力されます。 ![[Pasted image 20250316230316.png|frame]] *デフォルトのデバッグ情報* 『動作確認より前に、デバッグ情報？』と思うかもしれません。しかし、これは[[CodeCompanion]]で[[アダプタ (CodeCompanion)|アダプタ]]やモデルを確認するのに確実な方法です。以下の部分から読み取れます。 ```lua -- Adapter: "Anthropic" -- -- local settings = { model = "claude-3-7-sonnet-20250219", ``` ### アダプタの設定 [デフォルトでは `Anthoropic` になっています](https://codecompanion.olimorris.dev/configuration/adapters.html#changing-the-default-adapter)。[[Anthropic]]のAPIが利用できるのであればそのまま使いましょう。私は[[GitHub Copilot]]を使っているため、デフォルトの[[アダプタ (CodeCompanion)|アダプタ]]を `Copilot` にします。 `./envs/code-companion.lua` に `opts.strategies.chat.adapter` を追加します。 ```lua return { opts = { -- [追加] strategies = { chat = { -- デフォルトの "anthoropic" から変更 adapter = "copilot", }, }, }, } ``` [[Neovim]]を起動しなおして、[[チャットバッファ (CodeCompanion)|チャットバッファ]]でデバッグ情報を確認すると、以下のように出力内容が変わるはずです。 ```lua -- Adapter: "Copilot" -- -- local settings = { model = "gpt-4o", ``` ### アダプタの拡張 `Copilot` のデフォルトモデルは [[GPT-4o]] ですが、私の推しは [[Claude 3.7 Sonnet]] です。[[デフォルトモデルを変更 (CodeCompanion)|デフォルトモデルを変更]]するため[[ベースアダプタを継承 (CodeCompanion)|ベースアダプタを継承]]した[[アダプタ (CodeCompanion)|アダプタ]]を設定します。 `./envs/code-companion.lua` に `opts.adapters.copilot` を追加します。 ```lua return { opts = { strategies = { chat = { adapter = "copilot", }, inline = { adapter = "copilot", }, }, -- [追加] adapters = { -- copilotアダプタを上書き copilot = function() -- 既定のcopilotアダプタをベースに return require("codecompanion.adapters").extend("copilot", { schema = { model = { -- デフォルトモデルを Claude 3.7 Sonnet に default = "claude-3.7-sonnet", }, }, }) end, }, }, } ``` 再起動してデバッグ情報を確認し、`settings.model` が変わっていればOKです。 ```lua -- Adapter: "Copilot" -- -- local settings = { model = "claude-3.7-sonnet", ``` ### 認証情報を設定する どの[[アダプタ (CodeCompanion)|アダプタ]]を使うにせよ認証情報が必要です。[[アダプタ (CodeCompanion)|アダプタ]]ごとに必要な情報は、公式ドキュメントの [Plugin Overview](https://codecompanion.olimorris.dev/#plugin-overview) に記載されています。これらを準備した上で、環境変数などに設定します。 `Copilot` アダプタの場合は [[copilot.vim]] または [[copilot.lua]] プラグインの初期設定で生成されるトークンが必要になります。 > Copilot (copilot) - Requires a token which is created via :Copilot setup in Copilot.vim 私は[[copilot.lua]]を使っているので、追加の作業は必要ありませんでした。 > [!hint] copilot.lua で認証が行われない場合 > [[WSL]]を使っている場合はハマる可能性が高いです。[[📝copilot.luaでCopilot authコマンドを実行しても何も起こらず認証できない]] の回避策を参考にしてください。 ### 動作確認する `Hello` と入力して、[[ノーマルモード]]で `Enter` を押します。見た目のフィードバックはありませんが、しばらくして返答が表示されればOKです。 ![[Pasted image 20250317000052.png]] エラーが出る場合は設定不備の可能性が高いです。エラーメッセージを参考にして確認しましょう。 > [!hint] > [[Claude 3.7 Sonnet]]など一部のモデルは、一度[[VSCode]]の[[GitHub Copilot]]拡張で稼働実績がないとエラーになる場合があります。エラーメッセージからその旨は読み取れませんので、ハマったら一度[[VSCode]]の[[GitHub Copilot]]拡張で動作確認してみましょう。 ## チャットを使いやすくする いくつか設定をして[[チャットバッファ (CodeCompanion)|チャットバッファ]]を使いやすくします。 ### 返答を日本語にする 返答は日本語の方が楽なので[[日本語で回答 (CodeCompanion)|日本語で回答]]してもらえるようにします。`./plugins/code-companion.lua` に `opts.language` を設定します。 ```lua local base_opts = { -- [追加] opts = { language = "Japanese", }, } ``` `hello` の返答が日本語になればOKです。 ![[Pasted image 20250317074736.png]] ### 自動スクロールを無効化する デフォルトではチャットの返答にあわせて自動で下へとスクロールされます。 ![[2025-03-17-22-11-08.webm]] これは返答を上から順番に確認したいときは不便です。特に事前のやりとりがいくつか溜まっていると、前回の投稿を探して戻る必要があります[^1]。これは無駄な作業です。 [^1]: `]]` と `[[` で見出しレベルの前後移動ができるため、実際にはそこまで困りませんが... [[自動スクロールを無効 (CodeCompanion)|自動スクロールを無効]]にするために設定変更します。 ```lua local base_opts = { opts = { language = "Japanese", }, -- [追加] display = { chat = { auto_scroll = false, }, }, } ``` ### 見た目を向上させる デフォルトの表示はシンプルすぎるので、何点か見た目の設定変更をします。 #### prefixアイコンをつける 設定に `strategies.chat.roles` を追加し、その配下 `llm` と `user` にプロンプト表示文字列を指定します。 ```lua local base_opts = { opts = { language = "Japanese", }, display = { chat = { auto_scroll = false, }, }, -- [追加] strategies = { chat = { roles = { llm = function(adapter) return " CodeCompanion (" .. adapter.formatted_name .. ")" end, user = " Me", }, }, }, } ``` 再び起動すると以下のように楽しげなプロンプトへと変化します。 ![[Pasted image 20250317223216.png]] #### Markdownの表示をリッチにする デフォルトでは[[Markdown]]はraw textがそのまま表示されます。 ![[Pasted image 20250317223735.png|frame]] *少し味気ないかも...* 見た目をリッチにするため、[[render-markdown.nvim]]をインストールしていなければインストールしましょう。[[ファイルタイプ (Vim)|ファイルタイプ]] `codecompanion` を設定に追加する必要があります。 ```lua return { "MeanderingProgrammer/render-markdown.nvim", dependencies = { "nvim-treesitter/nvim-treesitter", "echasnovski/mini.icons" }, -- [変更] "codecompanion" を追加 ft = { "markdown", "markdown.mdx", "Avante", "codecompanion" }, opts = { -- [変更] "codecompanion" を追加 file_types = { "markdown", "Avante", "codecompanion" }, -- 中略 } } ``` [[render-markdown.nvim]]のリッチな表現が適応されます。 ![[Pasted image 20250317224338.png]] #### 区切りを見やすくする 見出し表示で強調されているとはいえ、大量のやりとりを行うと区切りが分かりにくくなります。`show_header_separator` に `true` を設定して[[投稿の境目に区切り線を表示 (CodeCompanion)|投稿の境目に区切り線を表示]]しましょう。 ```lua local base_opts = { opts = { language = "Japanese", }, display = { chat = { auto_scroll = false, -- [追加] show_header_separator = true, }, }, strategies = { chat = { roles = { llm = function(adapter) return " CodeCompanion (" .. adapter.formatted_name .. ")" end, user = " Me", }, }, }, } ``` ![[Pasted image 20250317230601.png|frame]] *やりとりの境目が一目で分かるように* ### AIの思考中にローディングスピナーを表示する 現状は、質問してから回答が書き込まれるまでの間に一切反応がありません。ちゃんと動いているのか不安になるので、ローディングスピナーを表示します。 <div class="link-card-v2"> <div class="link-card-v2-site"> <img class="link-card-v2-site-icon" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/favicon-64.png" /> <span class="link-card-v2-site-name">Minerva</span> </div> <div class="link-card-v2-title"> 📜2025-02-05 CodeCompanionの実行中にローディングスピナーを表示する </div> <div class="link-card-v2-content">CodeCompanionを実行中、思考が長いモデルについては結果が表示されるまで中身が更新されないので不安になる。また、Azure OpenAI Serviceのo1モデルはstreamに対応していなかったので、表示までに時間がかかる。絶賛処理中であることを明示的に分かるようにしたい。</div> <img class="link-card-v2-image" src="https://publish-01.obsidian.md/access/35d05cd1bf5cc500e11cc8ba57daaf88/Notes/attachments/activity.webp" /> <a data-href="📜2025-02-05 CodeCompanionの実行中にローディングスピナーを表示する" class="internal-link"></a> </div> %%[[📜2025-02-05 CodeCompanionの実行中にローディングスピナーを表示する]]%% 上のページでは[[Fidget]]を使う例と[[lualine.nvim]]を使う例を紹介していますが、ここでは[[Fidget]]を使用した動画を紹介します。 ![[2025-03-19-20-40-00.webm]] ### 投稿キーを変更する これは好みですが、`Ctrl+Enter` の方がしっくりくるので[[チャットバッファのキーマップを変更 (CodeCompanion)|キーマップを変更]]します。 ```lua local base_opts = { opts = { language = "Japanese", }, display = { chat = { auto_scroll = false, show_header_separator = true, }, }, strategies = { chat = { roles = { llm = function(adapter) return " CodeCompanion (" .. adapter.formatted_name .. ")" end, user = " Me", }, -- [追加] keymaps = { send = { modes = { n = "<F12>", i = "<F12>" }, -- Ctrl+Enter }, }, }, }, } ``` ### 起動キーを設定する 毎回 `:CodeCompanionChat` と入力するのは面倒なので、ホットキーを設定しましょう。[[lazy.nvim]]の場合は以下のように設定します。 ```lua return { "olimorris/codecompanion.nvim", -- [追加] keys = { { "<Space>cf", ":CodeCompanion<CR>", mode = { "n", "v" }, silent = true, }, { "<Space>cc", ":CodeCompanionChat<CR>", mode = { "n", "v" }, silent = true, }, { "<Space>ca", ":CodeCompanionAction<CR>", mode = { "n", "v" }, silent = true, }, }, -- 中略 } ``` `<Space>cc` は[[チャットバッファ (CodeCompanion)|チャットバッファ]]の起動です。他2つのコマンドは後ほど登場します。 ## 実際の開発でよく使うユースケース 基本的な設定も済んだところで、実際に開発するときよく遭遇するケースをもとに、[[CodeCompanion]]の具体的な使い方を紹介します。 ### 選択範囲の内容 + プロンプトでコードを変更してもらう 実装したい関数の説明だけ書いたものの、実装が面倒... というシーンを思い浮かべてください。 ![[Pasted image 20250318224946.png]] ドキュメントを選択して `:CodeCompanion` コマンドを実行します。 ![[Pasted image 20250318225222.png|frame]] *[[ビジュアルモード]]でドキュメントを選択* ![[Pasted image 20250318225325.png|frame]] *`CodeCompanion` コマンド を実行* ![[Pasted image 20250318225337.png|frame]] *依頼内容を入力する* ![[Pasted image 20250318225425.png|frame]] *実装結果とdiffが表示される* 左側がAIが生成した変更後のコード、右側がAIを使う前のコードです。問題なければ、右側の[[ウィンドウ (Vim)|ウィンドウ]]を閉じ、左側の[[ウィンドウ (Vim)|ウィンドウ]]でそのまま作業を続けます。 ![[Pasted image 20250318225730.png|frame]] *右側の一時バッファウィンドウを閉じたあと* > [!hint] > [[copilot.lua]]のサジェストを使った方が速い場合もあります。ケースバイケースで適切な方を使い分けていきましょう。 ### 選択範囲のコードを説明してもらう コードリーディングをしているものの、メソッドの実装がよく分からない... というシーンを思い浮かべてください。 ![[Pasted image 20250319210027.png|frame]] *`M:init()` が何をやっているのか分からない...* ドキュメントを選択して `:CodeCompanionActions` コマンドを実行します。 ![[Pasted image 20250319211552.png|frame]] ビジュアルモードで `M:init()` のコードを選択 ![[Pasted image 20250319211714.png|frame]] *`CodeCompanionActions`コマンドを実行 * [[アクションパレット (CodeCompanion)|アクションパレット]]が起動します。 ![[Pasted image 20250319212126.png]] `explain` と入力し `Explain` が絞り込まれたら決定します。 ![[Pasted image 20250319212234.png]] 自動で[[チャットバッファ (CodeCompanion)|チャットバッファ]]が開くので、返答を待ちます。 ![[Pasted image 20250319212324.png]] しばらくすると、返答が表示されます。 ![[Pasted image 20250319212400.png]] ### エラーの原因を説明・修正してもらう [[Rust]]などの難しい言語は、[[LSP]]エラーになってしまうけど、原因が修正方法がよく分からない...ということも少なくないと思います。そのようなときも[[CodeCompanion]]は頼もしい先生になってくれます。 ![[Pasted image 20250320153403.png|frame]] *コンパイルが通らないRustのコード* [[チャットバッファ (CodeCompanion)|チャットバッファ]]を開き、2つの変数[[CodeCompanion]] `#buffer` と `#lsp` を入力します。 ![[Pasted image 20250320154243.png|frame]] *`#` をｎ入力すると変数が補完される* この状態で送信すると、直前の[[バッファ (Vim)|バッファ]]に含まれるコードの内容と[[LSP]]の出力結果を共有できます。つまり、[[LSP]]が出力しているエラーの情報と現在のソースコード内容を伝えることができ、具体的な返答を得られます。 > [!hint] > 追加で詳細な指示をしたい場合は `#buffer` や `#lsp` を追加したあとに、いつも通り自然言語で記載しましょう。 ![[Pasted image 20250320154525.png|frame]] *送信すると共有情報が表示される* ![[Pasted image 20250320154642.png|frame]] *エラーの原因と解決方法を示してくれる* [[Neovim]]の場合、コード修正は手動で行った方が速いケースも多いです... が、せっかくなので[[CodeCompanion]]にお願いしてみます。`@editor` [[ツール (CodeCompanion)|ツール]]を利用することで、[[バッファ (Vim)|バッファ]]内容を直接変更してくれます。 ![[Pasted image 20250320161223.png|frame]] *`@editor` でツール指定* ![[Pasted image 20250320161329.png|frame]] *共有情報にも追加される* 返答が返ってくると、編集前後の差分が[[diffモード (Neovim)|diffモード]]で表示されます。左が編集後、右が編集前のコードです。 ![[Pasted image 20250320161645.png]] 先ほどは右側の[[ウィンドウ (Vim)|ウィンドウ]]を閉じましたが、この画面ではいくつかキーマップが設定されています。 | キーバインド | アクション | 備考 | | ------------ | ------------------------------------- | ---------------------- | | `]c` | 次のdiffへ移動 | [[Neovim]]のキーマップ | | `[c` | 前のdiffへ移動 | [[Neovim]]のキーマップ | | `dp` | 現在の提案を受け入れる | [[Neovim]]のキーマップ | | `do` | 現在の提案を拒否する | [[Neovim]]のキーマップ | | `ga` | すべての提案を受け入れる (**a**ccept) | | | `gr` | すべての提案を拒否する (**r**eject) | | 今回の場合だと `ga` と入力することでシームレスに[[CodeCompanion]]の編集提案を受け入れ、作業を継続できます。 ![[Pasted image 20250320163037.png|frame]] *`ga`で変更提案を受け入れたあとの状態 * ### リファクタリングしてもらう [[#選択範囲の内容 + プロンプトでコードを変更してもらう]] ではドキュメントの内容から実装コードを書いてもらいました。非常に似たケースですが、入力がドキュメントではなくソースコードになります。 選択範囲を指定して、`:CodeCompanion` コマンドからリファクタリングを指示します。せっかくなので前回とは少し違うコマンドを実行します。 ![[Pasted image 20250320164339.png|frame]] *リファクタリング対象の関数を選択* `:CodeCompanion` コマンドの引数に直接指示を入力します。 ![[Pasted image 20250320164453.png]] すると、プロンプト入力画面をすっ飛ばして結果が表示されます。 ![[Pasted image 20250320164654.png]] 問題なければ `ga` でacceptして完了です。 > [!hint] > 今回の手順でなくても、[[チャットバッファ (CodeCompanion)|チャットバッファ]]から[[変数 (CodeCompanion)|変数]]や[[ツール (CodeCompanion)|ツール]]を用いて、リファクタリング対象の関数名を名指しで伝えたりする方法もあります。同じ目的に対して、異なる多くのアプローチが存在するのも、[[CodeCompanion]]の柔軟性であり魅力であるのかもしれません。 ### テストを書いてもらう 実装はしたけどテストコードを書くのが面倒... 特に既存テストコードが存在しないのであれば、なおさらそう思うこともあるでしょう。仕様または実装から、[[CodeCompanion]]にテストコードを書いてもらいます。 まずは **入力として与えたい情報を選択** し、[[チャットバッファ (CodeCompanion)|チャットバッファ]]を起動します。今回は **実装ではなくdocsと関数シグニチャをインプット** としてテストを書いてもらうケースを紹介します。 ![[Pasted image 20250320165529.png|frame]] *関数すべてではなくdocsとシグニチャの部分だけを選択* ![[Pasted image 20250320165617.png|frame]] *選択範囲はチャットバッファに入力される* 新しくテストファイルを作成したいので、`@files` [[ツール (CodeCompanion)|ツール]]でファイル作成・編集を許可します。併せて指示を記載します。今回のケースでは[[CodeCompanion]]にファイル名が伝わっていないため、そこはフォローします。 ![[Pasted image 20250320172615.png]] 実際にファイルシステムに処理する際は許可を求められます。`[Y]es` が選択された状態で `Enter` を押します。 ![[Pasted image 20250320172023.png]] > [!caution] > [[自動ツールモード (CodeCompanion)|自動ツールモード]]を使うと許可の確認をスキップできます。しかし、そのような処理は元に戻すことのできないケースが多く、そのような準備なしではオススメしません。 処理が終わると、`lib_test.go` が作成されていることを確認できます。自動でファイルが開くことはないので、[[Neovim]]から `lib_test.go` を手動で開いてください。 ![[Pasted image 20250320172710.png]] > [!note] > 組み込みの `Edit<->Test` [[ワークフロー (CodeCompanion)|ワークフロー]]を使うことで、テストが成功するまでコード編集と実行を繰り返すことができます。ただ、APIもしくは[[CodeCompanion]]が不安定なせいか、中途半端に止まってしまうことが多かったので、利用シーンは限られるのかもしれません。 ### 選択テキストを英語に翻訳してもらう 私は英語が苦手です。変数名やメソッド名ならまだしも、docsのような文章を英語で書くことは大変時間かがかかります。[[CodeCompanion]]に選択したテキストを英語に翻訳・変換してもらいましょう。 [[#選択範囲の内容 + プロンプトでコードを変更してもらう]] と同様の方法でも実現できますが、実行の機会が多いため毎回入力するのは面倒です。できれば以下のようにしたいです。 - ホットキーで実行できる - モデルは[[GPT-4o]]を使う - [[Claude 3.7 Sonnet]]は短文の翻訳用途には勿体ないし遅い [[プロンプトライブラリ (CodeCompanion)|プロンプトライブラリ]]に独自の[[プロンプト (CodeCompanion)|プロンプト]]を追加して、上記を実現します。 ```lua local base_opts = { opts = { language = "Japanese" }, display = { chat = { auto_scroll = false, show_header_separator = true, }, }, strategies = { chat = { roles = { llm = function(adapter) return " CodeCompanion (" .. adapter.formatted_name .. ")" end, user = " Me", }, keymaps = { send = { modes = { n = "<F12>", i = "<F12>" }, -- Ctrl+Enter }, }, }, }, -- [追加] prompt_library = { ["Translate to English"] = { strategy = "inline", description = "選択したテキストを英語に翻訳します", opts = { short_name = "trans_to_en", modes = { "v" }, adapter = { name = "copilot", model = "gpt-4o", }, -- INFO: コードを見るとstrategy = "inline" で対応してなさそう -- ignore_system_prompt = true, }, prompts = { { role = "system", content = "あなたは優れた開発者であり、日本語と英語のプロ翻訳者でもあります。", }, { role = "user", content = "<user_prompt>選択したコードドキュメントを英語に変換してください。</user_prompt>", }, }, }, }, } ``` 実行してみます。 ![[2025-03-20-22-48-06.webm]] ## まとめ [[CodeCompanion]]について、導入からオススメの初期設定の仕方を紹介しました。また、多様な機能を、実際に開発で利用することの多いユースケースを取り上げつつ、いくつか紹介しました。 分量と時間の関係で、今回紹介できなかった機能もあります。たとえば、[[ワークフロー (CodeCompanion)|ワークフロー]]は[[AIエージェント]]として利用するためには必須となる機能でしょう。 <div class="link-card-v2"> <div class="link-card-v2-site"> <span class="link-card-v2-site-name">codecompanion.olimorris.dev</span> </div> <div class="link-card-v2-title"> Using Workflows | CodeCompanion </div> <div class="link-card-v2-content"> AI-powered coding, seamlessly in Neovim </div> <a href="https://codecompanion.olimorris.dev/usage/workflows.html"></a> </div> また、生成されるコードや質問の返答に対するクオリティを上げるためには、ソースコードプロジェクトのコンテキストを知る必要があります。私はまだ触ったことがありませんが、[[ワークスペース (CodeCompanion)|ワークスペース]]はまさにそれにあたる機能です。 <div class="link-card-v2"> <div class="link-card-v2-site"> <span class="link-card-v2-site-name">codecompanion.olimorris.dev</span> </div> <div class="link-card-v2-title"> Creating Workspaces | CodeCompanion </div> <div class="link-card-v2-content"> AI-powered coding, seamlessly in Neovim </div> <a href="https://codecompanion.olimorris.dev/extending/workspace.html"></a> </div> さらに、最近流行りの[[MCPサーバー]]との連携も実現し始めています。 <div class="link-card-v2"> <div class="link-card-v2-site"> <img class="link-card-v2-site-icon" src="https://github.githubassets.com/favicons/favicon.svg" /> <span class="link-card-v2-site-name">GitHub</span> </div> <div class="link-card-v2-title"> 🚀 CodeCompanion + MCP Servers · olimorris/codecompanion.nvim · Discussion #1058 </div> <div class="link-card-v2-content"> 🚀 CodeCompanion + MCP Servers Hey folks! I wanted to share a Neovim plugin I've been working on called mcphub.n ... </div> <img class="link-card-v2-image" src="https://opengraph.githubassets.com/498cfcd7da85f85fa58bd6a68ec39abb0f6ce4bcb2a118a855ca7a3c01bb3c69/olimorris/codecompanion.nvim/discussions/1058" /> <a href="https://github.com/olimorris/codecompanion.nvim/discussions/1058"></a> </div> [[VSCode]]に比べれば、特にUI面で大きなハンデのある[[Neovim]]ですが、周辺のエコシステムが成熟していけば、また覇権に返り咲く日も遠くないのかなと思いました。そのときのために、[[VSCode]] x [[GitHub Copilot]] だけでなく、[[CodeCompanion]]もウォッチし続けていきたいと改めて思いました。 ## エピローグ カイジくんに褒めてもらえました 😊 ![[Pasted image 20250320225613.png]]