{ lib, config, ... }: let inherit (lib.options) mkEnableOption mkOption literalExpression literalMD; inherit (lib.types) str attrsOf nullOr either listOf; inherit (lib.generators) mkLuaInline; inherit (lib.nvim.binds) mkMappingOption; inherit (lib.nvim.types) mkPluginSetupOption luaInline mergelessListOf pluginType; inherit (lib.nvim.lua) toLuaObject; inherit (builtins) isString; cfg = config.vim.autocomplete.nvim-cmp; in { options.vim.autocomplete.nvim-cmp = { enable = mkEnableOption "nvim-cmp"; setupOpts = mkPluginSetupOption "the autocomplete plugin" { completion.completeopt = mkOption { type = str; default = "menu,menuone,noinsert"; description = '' A comma-separated list of options for completion. See `:help completeopt` for the complete list. ''; }; sorting.comparators = mkOption { type = mergelessListOf (either str luaInline); default = [ (mkLuaInline "deprio(kinds.Text)") (mkLuaInline "deprio(kinds.Snippet)") "offset" "exact" "score" "kind" "length" "sort_text" ]; description = '' The comparator functions used for sorting completions. You can either pass a valid inline lua function (see `:help cmp-config.sorting.comparators`), or a string, in which case the builtin comparator with that name will be used. A `deprio` function and a `kinds` (`require("cmp.types").lsp.CompletionItemKind`) variable is provided above `setupOpts`. By passing a type to the function, the returned function will be a comparator that always ranks the specified kind the lowest. ''; apply = map ( c: if isString c then mkLuaInline ("cmp.config.compare." + c) else c ); }; }; mappings = { complete = mkMappingOption "Complete [nvim-cmp]" "<C-Space>"; confirm = mkMappingOption "Confirm [nvim-cmp]" "<CR>"; next = mkMappingOption "Next item [nvim-cmp]" "<Tab>"; previous = mkMappingOption "Previous item [nvim-cmp]" "<S-Tab>"; close = mkMappingOption "Close [nvim-cmp]" "<C-e>"; scrollDocsUp = mkMappingOption "Scroll docs up [nvim-cmp]" "<C-d>"; scrollDocsDown = mkMappingOption "Scroll docs down [nvim-cmp]" "<C-f>"; }; format = mkOption { type = nullOr luaInline; default = mkLuaInline '' function(entry, vim_item) vim_item.menu = (${toLuaObject cfg.sources})[entry.source.name] return vim_item end ''; defaultText = literalMD '' ```lua function(entry, vim_item) vim_item.menu = (''${toLuaObject config.vim.autocomplete.nvim-cmp.sources})[entry.source.name] return vim_item end ``` ''; description = '' The function used to customize the completion menu entries. This is outside of `setupOpts` to allow for an easier integration with lspkind.nvim. See `:help cmp-config.formatting.format`. ''; }; sources = mkOption { type = attrsOf (nullOr str); default = {}; description = "The list of sources used by nvim-cmp"; example = literalExpression '' { nvim-cmp = null; buffer = "[Buffer]"; } ''; }; sourcePlugins = mkOption { type = listOf pluginType; default = []; description = "List of source plugins used by nvim-cmp."; }; }; }