Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Fully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot
https://github.com/zbirenbaum/copilot.lua

copilot github-copilot lsp-server lua neovim nvim-cmp

Last synced: about 2 months ago
JSON representation

Fully featured & enhanced replacement for copilot.vim complete with API for interacting with Github Copilot

Host: GitHub
URL: https://github.com/zbirenbaum/copilot.lua
Owner: zbirenbaum
License: mit
Created: 2022-04-02T21:07:51.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-05-19T00:19:19.000Z (4 months ago)
Last Synced: 2024-05-19T01:26:25.061Z (4 months ago)
Topics: copilot, github-copilot, lsp-server, lua, neovim, nvim-cmp
Language: Lua
Homepage:
Size: 16 MB
Stars: 2,315
Watchers: 9
Forks: 62
Open Issues: 32
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-neovim - zbirenbaum/copilot.lua - Fully featured Lua replacement for [GitHub/copilot.vim](https://github.com/github/copilot.vim). (Completion / (requires Neovim 0.5))
awesome-vim-llm-plugins - zbirenbaum/copilot.lua

README

        # copilot.lua

This plugin is the pure lua replacement for [github/copilot.vim](https://github.com/github/copilot.vim).

Motivation behind `copilot.lua`

While using `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, this repository was created.

## Install

Install the plugin with your preferred plugin manager.

For example, with [packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua

use { "zbirenbaum/copilot.lua" }

```

### Authentication

Once copilot is running, run `:Copilot auth` to start the authentication process.

## Setup and Configuration

You have to run the `require("copilot").setup(options)` function in order to start Copilot.

If no options are provided, the defaults are used.

Because the copilot server takes some time to start up, it is recommend that you lazy load copilot.

For example:

```lua

use {

  "zbirenbaum/copilot.lua",

  cmd = "Copilot",

  event = "InsertEnter",

  config = function()

    require("copilot").setup({})

  end,

}

```

The following is the default configuration:

```lua

require('copilot').setup({

  panel = {

    enabled = true,

    auto_refresh = false,

    keymap = {

      jump_prev = "[[",

      jump_next = "]]",

      accept = "",

      refresh = "gr",

      open = ""

    },

    layout = {

      position = "bottom", -- | top | left | right

      ratio = 0.4

    },

  },

  suggestion = {

    enabled = true,

    auto_trigger = false,

    hide_during_completion = true,

    debounce = 75,

    keymap = {

      accept = "",

      accept_word = false,

      accept_line = false,

      next = "",

      prev = "",

      dismiss = "",

    },

  },

  filetypes = {

    yaml = false,

    markdown = false,

    help = false,

    gitcommit = false,

    gitrebase = false,

    hgcommit = false,

    svn = false,

    cvs = false,

    ["."] = false,

  },

  copilot_node_command = 'node', -- Node.js version must be > 18.x

  server_opts_overrides = {},

})

```

### panel

Panel can be used to preview suggestions in a split window. You can run the

`:Copilot panel` command to open it.

If `auto_refresh` is `true`, the suggestions are refreshed as you type in the buffer.

The `copilot.panel` module exposes the following functions:

```lua

require("copilot.panel").accept()

require("copilot.panel").jump_next()

require("copilot.panel").jump_prev()

require("copilot.panel").open({position, ratio})

require("copilot.panel").refresh()

```

### suggestion

When `auto_trigger` is `true`, copilot starts suggesting as soon as you enter insert mode. 

When `auto_trigger` is `false`, use the `next` or `prev` keymap to trigger copilot suggestion.

To toggle auto trigger for the current buffer, use `require("copilot.suggestion").toggle_auto_trigger()`.

Copilot suggestion is automatically hidden when `popupmenu-completion` is open. In case you use a custom

menu for completion, you can set the `copilot_suggestion_hidden` buffer variable to `true` to have the

same behavior. For example, with `nvim-cmp`:

```lua

cmp.event:on("menu_opened", function()

  vim.b.copilot_suggestion_hidden = true

end)

cmp.event:on("menu_closed", function()

  vim.b.copilot_suggestion_hidden = false

end)

```

The `copilot.suggestion` module exposes the following functions:

```lua

require("copilot.suggestion").is_visible()

require("copilot.suggestion").accept(modifier)

require("copilot.suggestion").accept_word()

require("copilot.suggestion").accept_line()

require("copilot.suggestion").next()

require("copilot.suggestion").prev()

require("copilot.suggestion").dismiss()

require("copilot.suggestion").toggle_auto_trigger()

```

### filetypes

Specify filetypes for attaching copilot.

Example:

```lua

require("copilot").setup {

  filetypes = {

    markdown = true, -- overrides default

    terraform = false, -- disallow specific filetype

    sh = function ()

      if string.match(vim.fs.basename(vim.api.nvim_buf_get_name(0)), '^%.env.*') then

        -- disable for .env files

        return false

      end

      return true

    end,

  },

}

```

If you add `"*"` as a filetype, the default configuration for `filetypes` won't be used anymore. e.g.

```lua

require("copilot").setup {

  filetypes = {

    javascript = true, -- allow specific filetype

    typescript = true, -- allow specific filetype

    ["*"] = false, -- disable for all other filetypes and ignore default `filetypes`

  },

}

```

### copilot_node_command

Use this field to provide the path to a specific node version such as one installed by nvm. Node.js version must be 18.x or newer.

Example:

```lua

copilot_node_command = vim.fn.expand("$HOME") .. "/.config/nvm/versions/node/v18.18.2/bin/node", -- Node.js version must be > 18.x

```

### server_opts_overrides

Override copilot lsp client settings. The `settings` field is where you can set the values of the options defined in [SettingsOpts.md](./SettingsOpts.md).

These options are specific to the copilot lsp and can be used to customize its behavior. Ensure that the name field is not overriden as is is used for

efficiency reasons in numerous checks to verify copilot is actually running. See `:h vim.lsp.start_client` for list of options.

Example:

```lua

require("copilot").setup {

  server_opts_overrides = {

    trace = "verbose",

    settings = {

      advanced = {

        listCount = 10, -- #completions for panel

        inlineSuggestCount = 3, -- #completions for getCompletions

      }

    },

  }

}

```

## Commands

`copilot.lua` defines the `:Copilot` command that can perform various actions. It has completion support, so try it out.

## Integrations

The `copilot.api` module can be used to build integrations on top of `copilot.lua`.

- [zbirenbaum/copilot-cmp](https://github.com/zbirenbaum/copilot-cmp): Integration with [`nvim-cmp`](https://github.com/hrsh7th/nvim-cmp).

- [AndreM222/copilot-lualine](https://github.com/AndreM222/copilot-lualine): Integration with [`lualine.nvim`](https://github.com/nvim-lualine/lualine.nvim).