helpers/neovim-plugin: make use of helpers.mkSettingsOption

lib/neovim-plugin.nix

@@ -3,28 +3,20 @@
   nixvimOptions,
 }:
 with lib; {
-  mkSettingsOption = pluginName: options:
+  mkSettingsOption = {
-    mkOption {
+    pluginName ? null,
-      type = with types;
+    options ? {},
-        submodule {
+    description ?
-          freeformType = with types; attrsOf anything;
+      if pluginName != null
-          inherit options;
+      then "Options provided to the `require('${pluginName}').setup` function."
-        };
+      else throw "mkSettingsOption: Please provide either a `pluginName` or `description`.",
-      description = ''
+    example ? null,
-        Options provided to the `require('${pluginName}').setup` function.
+  }:
-      '';
+    nixvimOptions.mkSettingsOption {
-      default = {};
+      inherit options description example;
-      example = {
-        foo_bar = 42;
-        hostname = "localhost:8080";
-        callback.__raw = ''
-          function()
-            print('nixvim')
-          end
-        '';
-      };
     };
 
+  # TODO: DEPRECATED: use the `settings` option instead
   extraOptionsOptions = {
     extraOptions = mkOption {
       default = {};