lib/plugins: make plugin optional when lazy-loading

lib/default.nix

@@ -46,6 +46,7 @@ lib.makeExtensible (
 
     inherit (self.options)
       defaultNullOpts
+      mkAutoLoadOption
       mkCompositeOption
       mkCompositeOption'
       mkLazyLoadOption

lib/options.nix

@@ -381,5 +381,18 @@ rec {
         }
       );
     };
+
+  mkAutoLoadOption =
+    cfg: name:
+    lib.mkOption {
+      description = ''
+        Whether to automatically load ${name} when neovim starts.
+      '';
+      type = types.bool;
+      default = !(cfg.lazyLoad.enable or false);
+      defaultText =
+        if cfg ? lazyLoad then lib.literalMD "`false` when lazy-loading is enabled." else true;
+      example = false;
+    };
 }
 // removed

lib/plugins/mk-neovim-plugin.nix

@@ -74,6 +74,7 @@ let
       options = lib.setAttrByPath loc (
         {
           enable = lib.mkEnableOption packPathName;
+          autoLoad = lib.nixvim.mkAutoLoadOption cfg packPathName;
           lazyLoad = lib.nixvim.mkLazyLoadOption packPathName;
         }
         // lib.optionalAttrs hasSettings {

lib/plugins/mk-vim-plugin.nix

@@ -67,6 +67,7 @@ let
       options = lib.setAttrByPath loc (
         {
           enable = lib.mkEnableOption packPathName;
+          autoLoad = lib.nixvim.mkAutoLoadOption cfg packPathName;
         }
         // settingsOption
         // extraOptions

lib/plugins/utils.nix

@@ -74,7 +74,12 @@
       };
 
       config = lib.mkIf cfg.enable {
-        extraPlugins = [ (cfg.packageDecorator cfg.package) ];
+        extraPlugins = [
+          {
+            plugin = cfg.packageDecorator cfg.package;
+            optional = !cfg.autoLoad;
+          }
+        ];
       };
     };
 }