copilot-status.nvim

KO | EN

gitlite — search

#react #python #android #java #machine-learning #nodejs #javascript #cpp #csharp #deep-learning #esp-idf #esp32

copilot-status.nvim

★ 31 Open GitHub ↗

Simple Copilot status indicator for Neovim

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# copilot-status.nvim

A [copilot.lua][copilot] status indicator for Neovim.

## Demo (status is shown in bottom right corner)

https://user-images.githubusercontent.com/23699599/211830740-1c6a07dd-bdf5-43f0-a35d-60e3c4584d44.mp4

Using [Nonicons][nonicons] for the Copilot symbols and my unreleased Octocolors theme (coming soon...).

## Requirements

- Neovim 0.8+
- [copilot.lua][copilot]
- A [patched font](https://www.nerdfonts.com) or a font like [Nonicons][nonicons] (which I recommend)
- A place where you can show the status indicator, like [lualine][lualine]

## (Minimal) installation

### lazy.nvim

```lua
{
  "jonahgoldwastaken/copilot-status.nvim",
  dependencies = { "copilot.lua" } -- or "zbirenbaum/copilot.lua"
  lazy = true,
  event = "BufReadPost",
}
```

### packer.nvim

```lua
use({
  "jonahgoldwastaken/copilot-status.nvim",
  after = { "zbirenbaum/copilot.lua" },
  event = "BufReadPost",
})
```

### vim-plug

```vim
Plug "jonahgoldwastaken/copilot-status.nvim", { "branch": "main" }
```

## Usage

`copilot-status` keeps track of two fields:

- **status** which is one of
  - "offline"
  - "loading"
  - "idle"
  - "warning"
  - "error"
- **message** which is only populated when an error occurs

You can get these values with `.status()` and manipulate them yourself, or use the provided `.status_string()` function, which turns the status into an icon and appends the optional "message" if it exists. You can [configure](#configuration) the icons yourself.

### Example with lualine

```lua
require('lualine').setup {
  sections = {
    lualine_x = {
      function() return require("copilot_status").status_string() end,
      cnd = function() return require("copilot_status").enabled() end,
    }
  }
}
```

## Configuration

`copilot-status` has little settings to adjust at the moment. Here are the defaults:

```lua
require('copilot_status').setup({
  icons = {
    idle = " ",
    error = " ",
    offline = " ",
    warning = "𥉉 ",
    loading = " ",
  },
  debug = false,
})
```

> Make sure `.setup()` is run before `.string()` or `.status_string()`, otherwise the plugin will just ignore your configuration.

## Acknowledgements

- [copilot.lua][copilot] for creating an incredibly easy API to work with
- [Nonicons][nonicons] for providing great icons for this plug-in

[nonicons]: https://github.com/yamatsum/nonicons
[copilot]: https://github.com/zbirenbaum/copilot.lua
[lualine]: https://github.com/nvim-lualine/lualine.nvim
[octicons]: https://github.com/ryanoasis/nerd-fonts/tree/gh-pages

copilot-status.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README