plugins/cmp: migrate all cmp sources to mkCmpPluginModule

MattSturgeon · MattSturgeon · commit 41214e5727b0 · 2025-02-07T11:07:25.000Z
diff --git a/plugins/by-name/cmp-ai/default.nix b/plugins/by-name/cmp-ai/default.nix
@@ -4,14 +4,18 @@
 }:
 let
   inherit (lib.nixvim) defaultNullOpts;
+  name = "cmp-ai";
 in
 lib.nixvim.plugins.mkNeovimPlugin {
-  name = "cmp-ai";
+  inherit name;
 
   maintainers = [ lib.maintainers.GaetanLepage ];
 
   imports = [
-    { cmpSourcePlugins.cmp_ai = "cmp-ai"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "cmp_ai";
+    })
   ];
 
   moduleName = "cmp_ai.config";
diff --git a/plugins/by-name/cmp-git/default.nix b/plugins/by-name/cmp-git/default.nix
@@ -2,12 +2,18 @@
   lib,
   ...
 }:
-lib.nixvim.plugins.mkNeovimPlugin {
+let
   name = "cmp-git";
+in
+lib.nixvim.plugins.mkNeovimPlugin {
+  inherit name;
   moduleName = "cmp_git";
 
   imports = [
-    { cmpSourcePlugins.git = "cmp-git"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "git";
+    })
   ];
 
   maintainers = [ lib.maintainers.GaetanLepage ];
diff --git a/plugins/by-name/cmp-tabby/default.nix b/plugins/by-name/cmp-tabby/default.nix
@@ -2,14 +2,18 @@
 let
   inherit (lib) types;
   inherit (lib.nixvim) defaultNullOpts;
+  name = "cmp-tabby";
 in
 lib.nixvim.plugins.mkNeovimPlugin {
-  name = "cmp-tabby";
+  inherit name;
 
   maintainers = [ lib.maintainers.GaetanLepage ];
 
   imports = [
-    { cmpSourcePlugins.cmp_tabby = "cmp-tabby"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "cmp_tabby";
+    })
   ];
 
   deprecateExtraOptions = true;
diff --git a/plugins/by-name/cmp-tabnine/default.nix b/plugins/by-name/cmp-tabnine/default.nix
@@ -2,14 +2,18 @@
 let
   inherit (lib) types;
   inherit (lib.nixvim) defaultNullOpts;
+  name = "cmp-tabnine";
 in
 lib.nixvim.plugins.mkNeovimPlugin {
-  name = "cmp-tabnine";
+  inherit name;
 
   maintainers = [ lib.maintainers.GaetanLepage ];
 
   imports = [
-    { cmpSourcePlugins.cmp_tabnine = "cmp-tabnine"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "cmp_tabnine";
+    })
   ];
 
   deprecateExtraOptions = true;
diff --git a/plugins/by-name/codeium-nvim/default.nix b/plugins/by-name/codeium-nvim/default.nix
@@ -4,9 +4,10 @@
 }:
 let
   inherit (lib.nixvim) defaultNullOpts;
+  name = "codeium-nvim";
 in
 lib.nixvim.plugins.mkNeovimPlugin {
-  name = "codeium-nvim";
+  inherit name;
   packPathName = "codeium.nvim";
   moduleName = "codeium";
 
@@ -51,9 +52,12 @@ lib.nixvim.plugins.mkNeovimPlugin {
     "wrapper"
   ];
 
-  # Register nvim-cmp association
   imports = [
-    { cmpSourcePlugins.codeium = "codeium-nvim"; }
+    # Register nvim-cmp association
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "codeium";
+    })
   ];
 
   settingsOptions = {
diff --git a/plugins/by-name/copilot-cmp/default.nix b/plugins/by-name/copilot-cmp/default.nix
@@ -2,13 +2,17 @@
 let
   inherit (lib) types;
   inherit (lib.nixvim) defaultNullOpts;
+  name = "copilot-cmp";
 in
 lib.nixvim.plugins.mkNeovimPlugin {
-  name = "copilot-cmp";
+  inherit name;
   moduleName = "copilot_cmp";
 
   imports = [
-    { cmpSourcePlugins.copilot = "copilot-cmp"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = "copilot";
+    })
   ];
 
   maintainers = [ lib.maintainers.GaetanLepage ];
diff --git a/plugins/by-name/crates/default.nix b/plugins/by-name/crates/default.nix
@@ -1,13 +1,21 @@
 { lib, ... }:
-lib.nixvim.plugins.mkNeovimPlugin {
+let
   name = "crates";
+in
+lib.nixvim.plugins.mkNeovimPlugin {
+  inherit name;
   packPathName = "crates.nvim";
   package = "crates-nvim";
 
   maintainers = [ lib.maintainers.GaetanLepage ];
 
   imports =
-    [ { cmpSourcePlugins.crates = "crates"; } ]
+    [
+      (lib.nixvim.modules.mkCmpPluginModule {
+        pluginName = name;
+        sourceName = name;
+      })
+    ]
     ++
     # TODO introduced 2024-12-12: remove after 25.05
     lib.nixvim.mkSettingsRenamedOptionModules [ "plugins" "crates-nvim" ]
diff --git a/plugins/by-name/papis/default.nix b/plugins/by-name/papis/default.nix
@@ -1,13 +1,21 @@
 { lib, pkgs, ... }:
-lib.nixvim.plugins.mkNeovimPlugin {
+let
   name = "papis";
+in
+lib.nixvim.plugins.mkNeovimPlugin {
+  inherit name;
   packPathName = "papis.nvim";
   package = "papis-nvim";
 
   maintainers = [ lib.maintainers.GaetanLepage ];
 
-  # papis.nvim is an nvim-cmp source too
-  imports = [ { cmpSourcePlugins.papis = "papis"; } ];
+  imports = [
+    # papis.nvim is an nvim-cmp source too
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = name;
+    })
+  ];
 
   extraOptions = {
     yqPackage = lib.mkPackageOption pkgs "yq" {
diff --git a/plugins/by-name/vim-dadbod-completion/default.nix b/plugins/by-name/vim-dadbod-completion/default.nix
@@ -1,8 +1,14 @@
 { lib, ... }:
-lib.nixvim.plugins.mkVimPlugin {
+let
   name = "vim-dadbod-completion";
+in
+lib.nixvim.plugins.mkVimPlugin {
+  inherit name;
   maintainers = [ lib.maintainers.BoneyPatel ];
   imports = [
-    { cmpSourcePlugins.vim-dadbod-completion = "vim-dadbod-completion"; }
+    (lib.nixvim.modules.mkCmpPluginModule {
+      pluginName = name;
+      sourceName = name;
+    })
   ];
 }
diff --git a/plugins/cmp/sources/_mk-cmp-plugin.nix b/plugins/cmp/sources/_mk-cmp-plugin.nix
@@ -1,3 +1,4 @@
+# TODO: Remove this legacy function in favor of using `mkCmpPluginModule` directly
 {
   lib,
   pkgs,
@@ -12,6 +13,8 @@
   ] { },
   maintainers ? [ lib.maintainers.GaetanLepage ],
   imports ? [ ],
+  # Whether to add a `plugin.*.blink` option, that uses blink.compat
+  mkCmpPluginModuleArgs ? { },
   ...
 }@args:
 lib.nixvim.plugins.mkVimPlugin (
@@ -24,8 +27,8 @@ lib.nixvim.plugins.mkVimPlugin (
     name = pluginName;
 
     imports = imports ++ [
-      # Register the source -> plugin name association
-      { cmpSourcePlugins.${sourceName} = pluginName; }
+      # Create the `plugin.*.cmp` option
+      (lib.nixvim.modules.mkCmpPluginModule (mkCmpPluginModuleArgs // { inherit pluginName sourceName; }))
     ];
   }
 )
diff --git a/plugins/cmp/sources/default.nix b/plugins/cmp/sources/default.nix
@@ -8,7 +8,7 @@ let
 
   # A list of most cmp source plugins, passed to mkCmpSourcePlugin.
   # More complex cmp sources can instead be defined as their own plugin
-  # and register their source-name association using the `cmpSourcePlugins` option.
+  # and import a module constructed by `lib.nixvim.modules.mkCmpPluginModule`.
   sources = [
     {
       pluginName = "cmp-async-path";
diff --git a/tests/test-sources/plugins/cmp/all-sources.nix b/tests/test-sources/plugins/cmp/all-sources.nix
@@ -1,6 +1,69 @@
 { pkgs, ... }:
 {
   all-sources =
+    {
+      config,
+      options,
+      lib,
+      pkgs,
+      ...
+    }:
+    {
+      config = lib.mkMerge [
+        {
+          plugins.cmp = {
+            enable = true;
+            autoEnableSources = false;
+          };
+
+          plugins.copilot-lua = {
+            enable = true;
+
+            settings = {
+              panel.enabled = false;
+              suggestion.enabled = false;
+            };
+          };
+        }
+        {
+          plugins =
+            let
+              disabledSources =
+                [
+                  # We do not provide the required HF_API_KEY environment variable.
+                  "cmp-ai"
+                  # Triggers the warning complaining about treesitter highlighting being disabled
+                  "otter"
+                  # Invokes the `nix` command at startup which is not available in the sandbox
+                  "cmp-nixpkgs-maintainers"
+                  # lspkind has its own `cmp` options, but isn't a nvim-cmp source
+                  "lspkind"
+                ]
+                # TODO: why is this disabled?
+                ++ lib.optionals (pkgs.stdenv.hostPlatform.system == "aarch64-linux") [
+                  "cmp-tabnine"
+                ];
+              cmpPluginNames = lib.pipe options.plugins [
+                # First, a manual blacklist
+                (lib.flip builtins.removeAttrs disabledSources)
+                # Filter for non-options (all plugins are plain attrsets, not options)
+                # i.e. remove rename aliases
+                (lib.filterAttrs (name: opt: !lib.isOption opt))
+                # Collect the plugin names
+                builtins.attrNames
+                # Filter for plugins that have a `cmp` option
+                (builtins.filter (name: config.plugins.${name} ? cmp))
+              ];
+            in
+            lib.genAttrs cmpPluginNames (name: {
+              enable = true;
+              cmp.enable = true;
+            });
+        }
+      ];
+    };
+
+  auto-enable-sources =
     { config, ... }:
     {
       plugins = {
