init/basic: deprecate vim.leaderKey

in favour of `vim.globals.mapleader` and `vim.globals.maplocalleader`

tmp

Co-authored-by: raf <raf@notashelf.dev>

modules/extra/deprecations.nix

@@ -59,5 +59,10 @@ in {
       With Trouble having so many different modes, and breaking changes
       upstream, it no longer makes sense, nor works, to toggle only Trouble.
     '')
+    # 2024-11-30
+    (mkRemovedOptionModule ["vim" "leaderKey"] ''
+      This has been deprecated in favor of using the more generic `vim.globals`
+      (you can use `vim.globals.mapleader` to change this instead).
+    '')
   ];
 }

modules/neovim/init/basic.nix

@@ -14,12 +14,6 @@
   cfg = config.vim;
 in {
   options.vim = {
-    leaderKey = mkOption {
-      type = str;
-      default = " ";
-      description = "The leader key used for `<leader>` mappings";
-    };
-
     colourTerm = mkOption {
       type = bool;
       default = true;
@@ -197,8 +191,6 @@ in {
       vim.o.tm = ${toLuaObject cfg.mapTimeout}
       vim.o.cursorlineopt = ${toLuaObject cfg.cursorlineOpt}
       vim.o.scrolloff = ${toLuaObject cfg.scrollOffset}
-      vim.g.mapleader = ${toLuaObject cfg.leaderKey}
-      vim.g.maplocalleader = ${toLuaObject cfg.leaderKey}
 
       ${optionalString cfg.undoFile.enable ''
         vim.o.undofile = true

modules/wrapper/rc/options.nix

@@ -101,7 +101,10 @@ in {
 
     globals = mkOption {
       type = attrs;
-      default = {};
+      default = {
+        mapleader = " ";
+        maplocalleader = ",";
+      };
       example = {"some_variable" = 42;};
       description = ''
         An attribute set containing global variable values