nix-community.nixvim/plugins/by-name/blink-copilot/default.nix

{ lib, ... }:
lib.nixvim.plugins.mkNeovimPlugin {
  name = "blink-copilot";
  package = "blink-copilot";

  maintainers = [ lib.maintainers.khaneliman ];

  description = ''
    Configurable GitHub Copilot suggestions source for the blink-cmp.

    ---

    This plugin should be configured through blink-cmp's `sources.providers` settings.

    `plugins.copilot-lua` will be enabled by default, to provide a working setup out-of-the-box.
    You may disable it by explicitly adding `plugins.copilot-lua.enable = false` to your
    configuration.

    For example:

    ```nix
    plugins.blink-cmp = {
      enable = true;
      settings.sources.providers = {
        copilot = {
          async = true;
          module = "blink-copilot";
          name = "copilot";
          score_offset = 100;
          # Optional configurations
          opts = {
            max_completions = 3;
            max_attempts = 4;
            kind = "Copilot";
            debounce = 750;
            auto_refresh = {
              backward = true;
              forward = true;
            };
          };
        };
      };
    };
    ```

    And then you can add it to blink-cmp's `sources.default` option:

    ```nix
    plugins.blink-cmp = {
      enable = true;
      settings.sources.default = [
        "lsp"
        "path"
        "luasnip"
        "buffer"
        "copilot"
      ];
    };
    ```
  '';

  # Configured through blink-cmp
  callSetup = false;
  hasLuaConfig = false;
  hasSettings = false;

  extraConfig = {
    plugins.copilot-lua.enable = lib.mkDefault true;
  };
}