docs(0.7): add breaking changes entry

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

tmp

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

docs/release-notes/rl-0.7.md

@@ -81,6 +81,16 @@ favor of nixfmt (more information can be found
 To migrate to `nixfmt`, simply change `vim.languages.nix.format.type` to
 `nixfmt`.
 
+### leader changes {#sec-leader-changes}
+
+This has been deprecated in favor of using the more generic `vim.globals` (you
+can use `vim.globals.mapleader` to change this instead).
+
+Rust specific keymaps now use `maplocalleader` instead of `localleader` by
+default. This is to avoid conflicts with other modules. You can change
+`maplocalleader` with `vim.globals.maplocalleader`, but it's recommended to set
+it to something other than `mapleader` to avoid conflicts.
+
 ## Changelog {#sec-release-0.7-changelog}
 
 [ItsSorae](https://github.com/ItsSorae):
@@ -201,7 +211,8 @@ To migrate to `nixfmt`, simply change `vim.languages.nix.format.type` to
   is bundled with nvf, if you enable the module, since there is no way to
   provide only the LSP server.
 
-- Add [`run.nvim`](https://github.com/diniamo/run.nvim) support for running code using cached commands.
+- Add [`run.nvim`](https://github.com/diniamo/run.nvim) support for running code
+  using cached commands.
 
 [Neovim documentation on `vim.cmd`]: https://neovim.io/doc/user/lua.html#vim.cmd()
 

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