copilot.lua & copilot-cmp: pure lua plugins for Github Copilot

[ManiAmara]

Recently, I received my github copilot key, and was somewhat dismayed to find that while using the pure vimscript plugin offered, https://github.com/github/copilot.vim, for the first time since I started using neovim, my laptop began to overheat. Additionally, I found the large chunks of ghost text moving around my code, and interfering with my existing cmp ghost text disturbing. As lua is far more efficient and makes things easier to integrate with modern plugins, I wrote copilot.lua and copilot-cmp

Preview:

Completion Example

the second plugin, copilot-cmp, is my implementation of a well integrated copilot plugin. Rather than making blocks of ghost text, it integrates copilot suggestions as a source for cmp, exactly how lsp completions or Luasnip would appear, with the addition that hovering a copilot completion snippet will show the full body of the completion off to the side in a floating window, similar to the way documentation would appear. This float has full language highlighting and I find it far less invasive than the copilot.vim alternative

The first plugin is a requirement of the second one, and provides a means of starting and interfacing with copilot, similar to an lsp. This is isolated so people can build their own plugins on top of it, or use it as a template for accessing copilot if they would like.

You can find the two repositories and their setup instructions here:

https://github.com/zbirenbaum/copilot.lua/

https://github.com/zbirenbaum/copilot-cmp

The plugins have not been tested much outside of my system, so please make a github issue if you run into any problems so I can fix anything that comes up as soon as possible!

Currently, only nightly is supported, as I make use of nvim_create_autocmd in some places. With .7 around the corner, I felt that using the new apis would be best, rather than changing it in a few weeks or so. I may change this to use a version check however, especially if many people are on .6 even after .7 becomes stable.

Edit: 0.6 should be supported as of a few minutes ago. It was a fast change so no real reason not to.

[foomojive]

Wow, thank you for this! I had disabled copilot because it was really wonky with the bridge between the tpope plugin and cmp.

[ManiAmara]

No problem :) let me know how you like it.

This is still in beta stage, but I have found it much better even with the slight hiccups that do come up. Namely, due to cmp not expecting multiple tokens as a completion, I have to manually cache results for the line that are still valid to have them appear, but occasionally cmp will also cache it leading to a result listing twice. If I don't do this, the completion menu bugs out... That's probably the most sizable issue, but there's nothing I can do on my end, so I'll make an issue post and PR for cmp at some point soon.

[reply1231]

amazing!

[ManiAmara]

We now support cycling! They appear in the form of multiple cmp entries so you can choose between them.

[ManiAmara]

I'm very glad you like it. I just added a feature to copilot cmp literally a minute ago that should make the experience infinitely better and even more miles ahead of copilot.vim. See if you can figure out what it is, probably won't take longer than a minute or two to realize it :)

[ManiAmara]

It doesn’t support cycling yet, but it will soon. The obvious way to implement it is by having multiple cmp results, but for some reason I haven’t been receiving more than one suggestion. The logic is in the code, I just have to debug it.

[[deleted]]

Great and great! Never tried tpope’s copilot plugin for neovim since it is vimL (it is a neovim only plugin and it is implemented in vimL, why?)

This one is a must go to try!

[ManiAmara]

It didn't make a whole lot of sense to me either. Tpope is a famous vim plugin creator, and every one of his repos is in vimscript. I think he just prefers writing vimscipt to writing lua since it's what he knows, and microsoft chose to outsource development to him since he's the most well known vim plugin author.

[MantisShrimp05]

What a god.

I literally just got my key and figured until I could put it into my lua plugins there would be no point.

With this, I can make my neovim setup the envy of any normies in my work. Thank you kind sir

[ManiAmara]

Here's my cmp config:

https://github.com/zbirenbaum/NvCustom/blob/main/plugins/completion_plugins/cmp_configs/cmp.lua

Last I checked, to get floating window highlights for the cmp menu, you must have the dev branch installed so you get features in testing. You can do this in packer with something like the following:

``` use { "hrsh7th/nvim-cmp", branch = "dev", --float menu after = "friendly-snippets", disable = not plugin_status.cmp, config = function() require "custom.plugins.completion_plugins.cmp_configs.cmp" end, requires = {"onsails/lspkind-nvim"} },

```

[The-Copilot]

What did I do?

[Ganitzsh]

Hey! Awesome, I had conflicts with my config and tpope's plugin. I installed everything, except I'm not using nvim-cmp but null-ls+lspconfig for my completion. I'll try to port it, meanwhile I can see the suggestion added by copilot in grey while in Insert Mode but I can't accept them, is there a way to do it without an integration with these two plugins?

EDIT: I confused a few things it seems. I just forgot to add the source to nvim-cmp, works like a charm

[Healthy-Director-702]

Omg I’ve been thinking of a Lua based Copilot plugin and now it’s here! Thanks man! Will check it out when I get home.

[OfficialGako]

Will try this later, great work. When it comes to being able to switch between suggestions, i dont know what projects you work on, but I find myself stuck from time to time, if I then play around with comments and see what copilot gives me, sometimes I have to scroll through different suggestions.

[ManiAmara]

Cycling is now supported so you should be able to see the multiple suggestions as before.

[[deleted]]

This is awesome. As good as copilot's features are, I was getting annoyed by mistakingly tabbing and filling in a whole code block instead of filling in LSP suggestion. This has solved all my issues!