plugins/cmp/auto-enable: warn if used alongside plugins.*.cmp

Author: MattSturgeon

plugins/cmp/auto-enable.nix

@@ -1,6 +1,7 @@
 {
   lib,
   config,
+  options,
   ...
 }:
 let
@@ -56,9 +57,46 @@ in
   };
 
   config = lib.mkIf (cfg.enable && cfg.autoEnableSources) (
+    let
+      enabledCmpPlugins = lib.pipe options.plugins [
+        # First, a manual blacklist
+        (lib.flip builtins.removeAttrs [
+          # lspkind has its own `cmp` options
+          "lspkind"
+        ])
+        builtins.attrValues
+        # Filter for non-options (all plugins are plain attrsets, not options)
+        # i.e. remove rename aliases
+        (builtins.filter (opt: !lib.isOption opt))
+        # Filter for plugins that have `cmp` enabled
+        (builtins.filter (opt: opt.cmp.value.enable or false))
+        # Collect the enable options' `loc`s
+        (builtins.catAttrs "enable")
+        (builtins.catAttrs "loc")
+        # Drop the `"enable"` part of the option-loc
+        (builtins.map (lib.lists.dropEnd 1))
+        # Render each plugin loc as an option string
+        (builtins.map lib.showOption)
+      ];
+    in
     lib.mkMerge [
       {
         warnings = lib.nixvim.mkWarnings "plugins.cmp" [
+          # Warn when the new and old systems are used together.
+          # `autoEnableSources` is incompatible with the new `plugins.*.cmp` options
+          # TODO:
+          # - Have `autoEnableSources` default to no `plugins.*.cmp` options being enabled?
+          # - Maybe warn when `autoEnableSources` has highestPrio 1500?
+          # - I'm not sure how best to migrate to having `plugins.*.cmp.enable` default to true...
+          {
+            when = enabledCmpPlugins != [ ];
+            message = ''
+              You have enabled `autoEnableSources` that tells Nixvim to automatically enable the source plugins with respect to the list of sources provided in `settings.sources`.
+              However, ${builtins.toString (builtins.length enabledCmpPlugins)} plugins have cmp integration configured via `plugins.*.cmp`:${
+                lib.concatMapStrings (opt: "\n- `${opt}`") enabledCmpPlugins
+              }
+            '';
+          }
           # TODO: expand this warning to ft & cmd sources lists and `showDefs` the offending definitions
           {
             when = lib.types.isRawType cfg.settings.sources;
@@ -87,6 +125,7 @@ in
         #   cmp-foo.enable = true;
         #   cmp-bar.enable = true;
         # }
+        # NOTE: we use an optionalAttrs here to avoid inf-recursion when `plugins.*.cmp` is used
         plugins = lib.mapAttrs' (source: name: {
           inherit name;
           value.enable = lib.mkIf (lib.elem source enabledSources) true;