ui/modes: rename to 'modes-nvim'; convert to freeform setupOpts

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ic9ce8702bca16c6a2f10bd35c9b194a36a6a6964

modules/plugins/ui/modes-nvim/config.nix

@@ -10,12 +10,11 @@
   cfg = config.vim.ui.modes-nvim;
 in {
   config = mkIf cfg.enable {
-    vim.startPlugins = [
-      "modes-nvim"
-    ];
-
-    vim.pluginRC.modes-nvim = entryAnywhere ''
-      require('modes').setup(${toLuaObject cfg.setupOpts})
-    '';
+    vim = {
+      startPlugins = ["modes-nvim"];
+      pluginRC.modes-nvim = entryAnywhere ''
+        require('modes').setup(${toLuaObject cfg.setupOpts})
+      '';
+    };
   };
 }

modules/plugins/ui/modes-nvim/modes-nvim.nix

@@ -0,0 +1,42 @@
+{lib, ...}: let
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.types) listOf bool either str float;
+  inherit (lib.nvim.types) mkPluginSetupOption luaInline;
+in {
+  options.vim.ui.modes-nvim = {
+    enable = mkEnableOption "prismatic line decorations for Neovim [modes.nvim]";
+
+    setupOpts = mkPluginSetupOption "modes.nvim" {
+      set_cursorline = mkOption {
+        type = bool;
+        default = false;
+        description = ''
+          Whether to enable nable cursorline initially, and disable cursorline
+          for inactive windows or ignored filetypes.
+        '';
+      };
+
+      line_opacity = {
+        visual = mkOption {
+          type = float;
+          default = 0.15;
+          example = 0.0;
+          description = "Opacity for cursorline and number background";
+        };
+      };
+
+      ignore = mkOption {
+        type = listOf (either str luaInline);
+        default = ["NvimTree" "TelescopePrompt" "!minifiles"];
+        description = ''
+          Disable modes highlights for specified filetypes or enable with
+          prefix "!" if otherwise disabled.
+
+          Can also be a function that returns a boolean value that disables modes
+          highlights when `true`. Use `lib.generators.mkLuaInline` if using a Lua
+          function.
+        '';
+      };
+    };
+  };
+}

modules/plugins/ui/modes/modes.nix

@@ -1,48 +0,0 @@
-{lib, ...}: let
-  inherit (lib.options) mkOption mkEnableOption;
-  inherit (lib.types) bool str float;
-  inherit (lib.nvim.types) mkPluginSetupOption;
-in {
-  options.vim.ui.modes-nvim = {
-    enable = mkEnableOption "modes.nvim's prismatic line decorations";
-
-    setupOpts = {
-      setCursorline = mkOption {
-        type = bool;
-        description = "Set a colored cursorline on current line";
-        default = false; # looks ugly, disabled by default
-      };
-
-      line_opacity = {
-        visual = mkOption {
-          type = float;
-          description = "Set opacity for cursorline and number background";
-          default = 0.0;
-        };
-      };
-
-      colors = mkPluginSetupOption "modes.nvim" {
-        copy = mkOption {
-          type = str;
-          description = "The #RRGGBB color code for the visual mode highlights";
-          default = "#f5c359";
-        };
-        delete = mkOption {
-          type = str;
-          description = "The #RRGGBB color code for the visual mode highlights";
-          default = "#c75c6a";
-        };
-        insert = mkOption {
-          type = str;
-          description = "The #RRGGBB color code for the visual mode highlights";
-          default = "#78ccc5";
-        };
-        visual = mkOption {
-          type = str;
-          description = "The #RRGGBB color code for the visual mode highlights";
-          default = "#9745be";
-        };
-      };
-    };
-  };
-}