/copilot.lua

Lua plugin for starting and interacting with github copilot

Primary LanguageLuaMIT LicenseMIT

copilot.lua

This plugin is the pure lua replacement for 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:

use { "zbirenbaum/copilot.lua" }

Authentication

Once copilot is started, 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. This can be done in multiple ways, the best one will depend on your existing config and the speed of your machine:

  1. On VimEnter event + defer (preferred method, works well with fast configs):
use {
  "zbirenbaum/copilot.lua",
  event = "VimEnter",
  config = function()
    vim.defer_fn(function()
      require("copilot").setup()
    end, 100)
  end,
}
  1. Load after statusline + defer (if option 1 causes statusline to flicker, try this):
use {
  "zbirenbaum/copilot.lua",
  after = "feline.nvim", -- whichever statusline plugin you use here
  config = function ()
    vim.defer_fn(function()
      require("copilot").setup()
    end, 100)
  end,
}
  1. On InsertEnter event (safest way to avoid startup lag):
    Note: suggestions may take a moment to start showing up.
use {
  "zbirenbaum/copilot.lua",
  event = "InsertEnter",
  config = function ()
    vim.schedule(function()
      require("copilot").setup()
    end)
  end,
}

The following is the default configuration:

require('copilot').setup({
  panel = {
    enabled = true,
    auto_refresh = false,
    keymap = {
      jump_prev = "[[",
      jump_next = "]]",
      accept = "<CR>",
      refresh = "gr",
      open = "<M-CR>"
    },
  },
  suggestion = {
    enabled = true,
    auto_trigger = false,
    debounce = 75,
    keymap = {
     accept = "<M-l>",
     next = "<M-]>",
     prev = "<M-[>",
     dismiss = "<C-]>",
    },
  },
  filetypes = {
    yaml = false,
    markdown = false,
    help = false,
    gitcommit = false,
    gitrebase = false,
    hgcommit = false,
    svn = false,
    cvs = false,
    ["."] = false,
  },
  copilot_node_command = 'node', -- Node version must be < 18
  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:

require("copilot.panel").accept()
require("copilot.panel").jump_next()
require("copilot.panel").jump_prev()
require("copilot.panel").open()
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:

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:

require("copilot.suggestion").is_visible()
require("copilot.suggestion").accept()
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:

require("copilot").setup {
  filetypes = {
    markdown = true, -- overrides default
    terraform = false, -- disallow specific filetype
  },
}

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

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 version must be < 18. The LTS version of node (16.17.0) is recommended.

Example:

copilot_node_command = vim.fn.expand("$HOME") .. "/.config/nvm/versions/node/v16.14.2/bin/node", -- Node version must be < 18

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. 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:

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.