plugins/blink-ripgrep: use mkBlinkPluginModule

Author: MattSturgeon

plugins/by-name/blink-ripgrep/default.nix

@@ -1,61 +1,43 @@
 { lib, ... }:
-lib.nixvim.plugins.mkNeovimPlugin {
+let
   name = "blink-ripgrep";
+in
+lib.nixvim.plugins.mkNeovimPlugin {
+  inherit name;
   packPathName = "blink-ripgrep.nvim";
   package = "blink-ripgrep-nvim";
 
   maintainers = [ lib.maintainers.khaneliman ];
 
-  description = ''
-    This plugin should be configured through blink-cmp's `sources.providers` settings.
-
-    For example:
-
-    ```nix
-    plugins.blink-cmp = {
-      enable = true;
-      settings.sources.providers = {
-        ripgrep = {
-          async = true;
-          module = "blink-ripgrep";
-          name = "Ripgrep";
-          score_offset = 100;
-          opts = {
-            prefix_min_len = 3;
-            context_size = 5;
-            max_filesize = "1M";
-            project_root_marker = ".git";
-            project_root_fallback = true;
-            search_casing = "--ignore-case";
-            additional_rg_options = {};
-            fallback_to_regex_highlighting = true;
-            ignore_paths = {};
-            additional_paths = {};
-            debug = false;
-          };
-        };
+  imports = [
+    (lib.nixvim.modules.mkBlinkPluginModule {
+      pluginName = name;
+      # TODO: compute a sane-default
+      key = "ripgrep";
+      sourceName = "Ripgrep";
+      module = "blink-ripgrep";
+      settingsExample = {
+        async = true;
+        score_offset = 100;
       };
-    };
-    ```
-
-    And then you can add it to blink-cmp's `sources.default` option:
+    })
+  ];
 
-    ```nix
-    plugins.blink-cmp = {
-      enable = true;
-      settings.sources.default = [
-        "lsp"
-        "path"
-        "luasnip"
-        "buffer"
-        "ripgrep"
-      ];
-    };
-    ```
-  '';
+  settingsExample = {
+    prefix_min_len = 3;
+    context_size = 5;
+    max_filesize = "1M";
+    project_root_marker = ".git";
+    project_root_fallback = true;
+    search_casing = "--ignore-case";
+    additional_rg_options = { };
+    fallback_to_regex_highlighting = true;
+    ignore_paths = { };
+    additional_paths = { };
+    debug = false;
+  };
 
   # Configured through blink-cmp
   callSetup = false;
   hasLuaConfig = false;
-  hasSettings = false;
 }

tests/test-sources/plugins/by-name/blink-ripgrep/default.nix

@@ -1,9 +1,11 @@
 {
   empty = {
+    plugins.blink-cmp.enable = true;
     plugins.blink-ripgrep.enable = true;
   };
 
   defaults = {
+    plugins.blink-cmp.enable = true;
     plugins.blink-ripgrep = {
       enable = true;
     };