plugins/telescope: iconsPackage -> icons provider options

plugins/by-name/telescope/default.nix

@@ -2,6 +2,7 @@
   lib,
   config,
   pkgs,
+  options,
   ...
 }:
 with lib;
@@ -9,7 +10,6 @@ let
   inherit (lib.nixvim)
     keymaps
     mkNullOrOption
-    mkPackageOption
     toLuaObject
     ;
 in
@@ -37,6 +37,17 @@ lib.nixvim.neovim-plugin.mkNeovimPlugin {
       ]
       "This option no longer has any effect now that the `plugin.telescope.keymaps` implementation uses `<cmd>`."
     )
+    # TODO: added 2024-09-20 remove after 24.11
+    (lib.mkRemovedOptionModule
+      [
+        "plugins"
+        "telescope"
+        "iconsPackage"
+      ]
+      ''
+        Please use `plugins.web-devicons` or `plugins.mini.modules.icons` with `plugins.mini.mockDevIcons` instead.
+      ''
+    )
   ];
 
   extraOptions = {
@@ -89,11 +100,6 @@ lib.nixvim.neovim-plugin.mkNeovimPlugin {
       '';
     };
 
-    iconsPackage = lib.mkPackageOption pkgs [
-      "vimPlugins"
-      "nvim-web-devicons"
-    ] { nullable = true; };
-
     batPackage = lib.mkPackageOption pkgs "bat" {
       nullable = true;
     };
@@ -101,7 +107,18 @@ lib.nixvim.neovim-plugin.mkNeovimPlugin {
 
   callSetup = false;
   extraConfig = cfg: {
-    extraPlugins = mkIf (cfg.iconsPackage != null) [ cfg.iconsPackage ];
+    # TODO: added 2024-09-20 remove after 24.11
+    plugins.web-devicons = mkIf (
+      !(
+        config.plugins.mini.enable
+        && config.plugins.mini.modules ? icons
+        && config.plugins.mini.mockDevIcons
+      )
+    ) { enable = mkOverride 1490 true; };
+    warnings = optional (options.plugins.web-devicons.enable.highestPrio == 1490) ''
+      Nixvim (plugins.telescope) `web-devicons` automatic installation is deprecated.
+      Please use `plugins.web-devicons` or `plugins.mini.modules.icons` with `plugins.mini.mockDevIcons` instead.
+    '';
 
     extraConfigVim = mkIf (cfg.highlightTheme != null) ''
       let $BAT_THEME = '${cfg.highlightTheme}'

tests/test-sources/plugins/by-name/git-worktree/default.nix

@@ -17,6 +17,8 @@
       updateOnChangeCommand = "e .";
       clearJumpsOnChange = true;
     };
+
+    plugins.web-devicons.enable = true;
   };
 
   telescopeDisabled = {

tests/test-sources/plugins/by-name/harpoon/default.nix

@@ -70,6 +70,8 @@
         ];
       };
     };
+
+    plugins.web-devicons.enable = true;
   };
 
   telescopeDisabled = {

tests/test-sources/plugins/by-name/neorg/default.nix

@@ -84,6 +84,8 @@
         enable = true;
         modules."core.integrations.telescope".__empty = null;
       };
+
+      web-devicons.enable = true;
     };
   };
 

tests/test-sources/plugins/by-name/octo/default.nix

@@ -3,6 +3,7 @@
     # This test is flaky and fails non-deterministically
     test.runNvim = false;
 
+    plugins.web-devicons.enable = true;
     plugins.octo.enable = true;
   };
 
@@ -10,6 +11,7 @@
     # This test is flaky and fails non-deterministically
     test.runNvim = false;
 
+    plugins.web-devicons.enable = true;
     plugins.octo = {
       enable = true;
 
@@ -30,12 +32,10 @@
     # This test is flaky and fails non-deterministically
     test.runNvim = false;
 
-    plugins = {
-      octo = {
-        enable = true;
-        settings.picker = "fzf-lua";
-      };
-      web-devicons.enable = true;
+    plugins.web-devicons.enable = true;
+    plugins.octo = {
+      enable = true;
+      settings.picker = "fzf-lua";
     };
   };
 
@@ -43,6 +43,7 @@
     # This test is flaky and fails non-deterministically
     test.runNvim = false;
 
+    plugins.web-devicons.enable = true;
     plugins.octo = {
       enable = true;
 
@@ -91,6 +92,7 @@
   no-packages = {
     # Need to add gh executable to runtime path for plugin
     test.runNvim = false;
+    plugins.web-devicons.enable = false;
     plugins.octo = {
       enable = true;
       ghPackage = null;

tests/test-sources/plugins/by-name/package-info/default.nix

@@ -37,6 +37,8 @@
         enable = true;
         enableTelescope = true;
       };
+
+      web-devicons.enable = true;
     };
   };
 }

tests/test-sources/plugins/by-name/project-nvim/default.nix

@@ -11,6 +11,7 @@
       enable = true;
       enableTelescope = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {

tests/test-sources/plugins/by-name/refactoring/default.nix

@@ -35,6 +35,8 @@
       enable = true;
       enableTelescope = true;
     };
+
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {

tests/test-sources/plugins/by-name/telescope/default.nix

@@ -1,9 +1,11 @@
 {
   empty = {
+    plugins.web-devicons.enable = true;
     plugins.telescope.enable = true;
   };
 
   example = {
+    plugins.web-devicons.enable = true;
     plugins.telescope = {
       enable = true;
 
@@ -19,6 +21,7 @@
   };
 
   combine-plugins = {
+    plugins.web-devicons.enable = true;
     plugins.telescope.enable = true;
 
     performance.combinePlugins.enable = true;
@@ -32,10 +35,19 @@
   };
 
   no-packages = {
+    plugins.web-devicons.enable = false;
     plugins.telescope = {
       enable = true;
       batPackage = null;
-      iconsPackage = null;
     };
   };
+
+  mini-icons = {
+    plugins.mini = {
+      enable = true;
+      mockDevIcons = true;
+      modules.icons = { };
+    };
+    plugins.telescope.enable = true;
+  };
 }

tests/test-sources/plugins/by-name/telescope/file-browser.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.file-browser.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {
@@ -82,5 +83,6 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 }

tests/test-sources/plugins/by-name/telescope/frecency.nix

@@ -7,6 +7,7 @@
       enable = true;
       extensions.frecency.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {
@@ -42,6 +43,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -72,5 +74,6 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 }

tests/test-sources/plugins/by-name/telescope/fzf-native.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.fzf-native.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {
@@ -21,6 +22,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   combine-plugins = {
@@ -28,6 +30,7 @@
       enable = true;
       extensions.fzf-native.enable = true;
     };
+    plugins.web-devicons.enable = true;
 
     performance.combinePlugins.enable = true;
   };

tests/test-sources/plugins/by-name/telescope/fzy-native.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.fzy-native.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -19,6 +20,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   combine-plugins = {
@@ -27,6 +29,7 @@
       extensions.fzy-native.enable = true;
     };
 
+    plugins.web-devicons.enable = true;
     performance.combinePlugins.enable = true;
   };
 }

tests/test-sources/plugins/by-name/telescope/live-grep-args.nix

@@ -5,6 +5,7 @@
       enable = true;
       extensions.live-grep-args.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   default = {
@@ -20,6 +21,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -42,6 +44,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   custom-packages = {
@@ -53,6 +56,7 @@
         grepPackage = pkgs.gnugrep;
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   no-packages = {
@@ -64,5 +68,6 @@
         grepPackage = null;
       };
     };
+    plugins.web-devicons.enable = false;
   };
 }

tests/test-sources/plugins/by-name/telescope/manix.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.manix.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   default = {
@@ -19,6 +20,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -34,6 +36,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   no-packages = {
@@ -45,5 +48,6 @@
         manixPackage = null;
       };
     };
+    plugins.web-devicons.enable = false;
   };
 }

tests/test-sources/plugins/by-name/telescope/media-files.nix

@@ -5,6 +5,7 @@
       enable = true;
       extensions.media-files.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   defaults = {
@@ -28,6 +29,7 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 
   dependencies = {
@@ -47,5 +49,6 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 }

tests/test-sources/plugins/by-name/telescope/ui-select.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.ui-select.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -18,5 +19,6 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 }

tests/test-sources/plugins/by-name/telescope/undo.nix

@@ -4,6 +4,7 @@
       enable = true;
       extensions.undo.enable = true;
     };
+    plugins.web-devicons.enable = true;
   };
 
   example = {
@@ -39,5 +40,6 @@
         };
       };
     };
+    plugins.web-devicons.enable = true;
   };
 }

tests/test-sources/plugins/by-name/todo-comments/default.nix

@@ -187,6 +187,7 @@
           };
         };
       };
+      plugins.web-devicons.enable = true;
     };
 
   without-ripgrep = {

tests/test-sources/plugins/by-name/yanky/default.nix

@@ -11,6 +11,8 @@
         enable = true;
         enableTelescope = true;
       };
+
+      web-devicons.enable = true;
     };
   };
 
@@ -66,6 +68,7 @@
       sqlite-lua.enable = true;
       telescope.enable = true;
 
+      web-devicons.enable = true;
       yanky = {
         enable = true;
 

tests/test-sources/plugins/utils/rest.nix

@@ -109,6 +109,7 @@
       };
       treesitter.enable = true;
       telescope.enable = true;
+      web-devicons.enable = true;
     };
   };
 }