@hexuhua/coc-copilot

20240621_173158.mp4

@hexuhua/coc-copilot is a coc.nvim extension that integrates with GitHub's copilot.vim to provide AI-powered code completions for your projects.

Note: There is another plugin called coc-copilot: https://github.com/yuki-yano/coc-copilot, but that repository is no longer maintained by the author. This is a different plugin. Make sure to install it using @hexuhua/coc-copilot and not coc-copilot.

Features

• Fetches code completions from copilot.vim.
• Integrates with coc.nvim's completion system.
• Customizable source priority, label, and limit.

Installation

Make sure you have coc.nvim and copilot.vim installed and configured.

Then, install @hexuhua/coc-copilot using:

:CocInstall @hexuhua/coc-copilot

Usage

Now coc-copilot doesn't support auto-updating completion panel. You need to update completions manually by coc#refresh():

inoremap <silent><expr><c-l> coc#refresh()

That is because asynchronous completion makes coc completion panel update slowly. See: Asynchronous Completion for isIncomplete Items in coc.nvim #5028

Configuration

Here are the available configuration options for coc-copilot:

• copilot.enable: (Boolean, default: true) Enable or disable the coc-copilot extension.
• copilot.timeout: (Integer, default: 5000) coc-copilot uses polling to get results from copilot.vim. If there is no result after <timeout> ms, then the polling ends. The value cannot be less than 500 because the interval of polling is 500ms, and the default value is 5000ms, which is the same as the default timeout of coc completion.
• copilot.priority: (Integer, default: 1000) The priority of Copilot completion items compared to other completion sources.
• copilot.limit: (Integer, default: 10) The maximum number of completion items fetched from Copilot.
• copilot.enablePreselect: (Boolean, default: true) Enable or disable preselecting Copilot completion items.
• copilot.kindLabel: (String, default: " ") The label used for Copilot completions in the completion menu.
• copilot.shortcut: (String, default: "Cop") The shortcut used for Copilot completions in the completion menu.
• copilot.showRemainingText: (Boolean, default: true) Whether to show the remaining text after the completion item in the completion menu. For some languages such as markdown, there is often a lot of text in one line, which can be helpful.
• copilot.autoUpdateCompletion: (Boolean, default: true) Whether to update the completion panel automatically when the copilot result is updated. Deprecated: Now coc-copilot no longer updates the completion panel automatically because asynchronous completion makes coc completion panel update slowly. See: Asynchronous Completion for isIncomplete Items in coc.nvim #5028

License

MIT License.

Q & A

• Q: What copilot.showRemainingText does?

• A: It shows the remaining text after the completion item in the completion menu. For some languages such as markdown, there is often a lot of text in one line, which can be helpful.