From b71bf75dcdf1c67ebb04f09be5b148a9ad17181e Mon Sep 17 00:00:00 2001
From: diniamo <55629891+diniamo@users.noreply.github.com>
Date: Mon, 12 Aug 2024 00:07:45 +0000
Subject: [PATCH 1/3] vim.maps rewrite (#352)

* feat: rewrite vim.maps

* modules/mappings: enable silent by default

* docs: add entry for vim.maps rewrite

* lib/binds: improve code, adjust functions to new api
---
 docs/release-notes/rl-0.7.md        |  26 ++++++
 lib/binds.nix                       | 121 ++++++++++++++--------------
 modules/neovim/mappings/config.nix  |  57 +++++--------
 modules/neovim/mappings/options.nix | 103 +++++++----------------
 modules/wrapper/rc/config.nix       | 117 ++++-----------------------
 5 files changed, 150 insertions(+), 274 deletions(-)

diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md
index 21edbdd..947025b 100644
--- a/docs/release-notes/rl-0.7.md
+++ b/docs/release-notes/rl-0.7.md
@@ -4,6 +4,8 @@ Release notes for release 0.7
 
 ## Breaking Changes and Migration Guide {#sec-breaking-changes-and-migration-guide-0-7}
 
+### `vim.configRC` removed
+
 In v0.7 we are removing `vim.configRC` in favor of making `vim.luaConfigRC` the
 top-level DAG, and thereby making the entire configuration Lua based. This
 change introduces a few breaking changes:
@@ -24,6 +26,28 @@ making good use of its extensive Lua API. Additionally, Vimscript is slow and
 brings unnecessary performance overhead while working with different
 configuration formats.
 
+### `vim.maps` rewrite
+
+Instead of specifying map modes using submodules (eg.: `vim.maps.normal`), a new
+`mode` option has mode has been introduced. It can be either a string, or a list
+of strings, where a string represents the short-name of the map mode(s), that
+the mapping should be set for. See `:help map-modes` for more information.
+
+For example:
+
+```nix
+vim.maps.normal."<leader>m" = { ... };
+```
+
+has to be replaced by
+
+```nix
+vim.maps."<leader>m" = {
+  mode = "n";
+  ...
+};
+```
+
 ## Changelog {#sec-release-0.7-changelog}
 
 [ItsSorae](https://github.com/ItsSorae):
@@ -114,6 +138,8 @@ configuration formats.
     has been introduced for setting up internal plugins. See the "DAG entries in
     nvf" manual page for more information.
 
+- Rewrite `vim.maps`, see the breaking changes section above.
+
 [NotAShelf](https://github.com/notashelf):
 
 [ts-error-translator.nvim]: https://github.com/dmmulroy/ts-error-translator.nvim
diff --git a/lib/binds.nix b/lib/binds.nix
index 8c9e9a6..a8fbf5f 100644
--- a/lib/binds.nix
+++ b/lib/binds.nix
@@ -4,69 +4,68 @@
   inherit (lib.types) nullOr str;
   inherit (lib.attrsets) isAttrs mapAttrs;
 
-  binds = rec {
-    mkLuaBinding = key: action: desc:
-      mkIf (key != null) {
-        "${key}" = {
-          inherit action desc;
-          lua = true;
-          silent = true;
+  mkLuaBinding = mode: key: action: desc:
+    mkIf (key != null) {
+      ${key} = {
+        inherit mode action desc;
+        lua = true;
+        silent = true;
+      };
+    };
+
+  mkExprBinding = mode: key: action: desc:
+    mkIf (key != null) {
+      ${key} = {
+        inherit mode action desc;
+        lua = true;
+        silent = true;
+        expr = true;
+      };
+    };
+
+  mkBinding = mode: key: action: desc:
+    mkIf (key != null) {
+      ${key} = {
+        inherit mode action desc;
+        silent = true;
+      };
+    };
+
+  mkMappingOption = description: default:
+    mkOption {
+      type = nullOr str;
+      inherit default description;
+    };
+
+  # Utility function that takes two attrsets:
+  # { someKey = "some_value" } and
+  # { someKey = { description = "Some Description"; }; }
+  # and merges them into
+  # { someKey = { value = "some_value"; description = "Some Description"; }; }
+  addDescriptionsToMappings = actualMappings: mappingDefinitions:
+    mapAttrs (name: value: let
+      isNested = isAttrs value;
+      returnedValue =
+        if isNested
+        then addDescriptionsToMappings actualMappings.${name} mappingDefinitions.${name}
+        else {
+          inherit value;
+          inherit (mappingDefinitions.${name}) description;
         };
-      };
+    in
+      returnedValue)
+    actualMappings;
 
-    mkExprBinding = key: action: desc:
-      mkIf (key != null) {
-        "${key}" = {
-          inherit action desc;
-          lua = true;
-          silent = true;
-          expr = true;
-        };
-      };
+  mkSetBinding = mode: binding: action:
+    mkBinding mode binding.value action binding.description;
 
-    mkBinding = key: action: desc:
-      mkIf (key != null) {
-        "${key}" = {
-          inherit action desc;
-          silent = true;
-        };
-      };
+  mkSetExprBinding = mode: binding: action:
+    mkExprBinding mode binding.value action binding.description;
 
-    mkMappingOption = description: default:
-      mkOption {
-        type = nullOr str;
-        inherit default description;
-      };
+  mkSetLuaBinding = mode: binding: action:
+    mkLuaBinding mode binding.value action binding.description;
 
-    # Utility function that takes two attrsets:
-    # { someKey = "some_value" } and
-    # { someKey = { description = "Some Description"; }; }
-    # and merges them into
-    # { someKey = { value = "some_value"; description = "Some Description"; }; }
-    addDescriptionsToMappings = actualMappings: mappingDefinitions:
-      mapAttrs (name: value: let
-        isNested = isAttrs value;
-        returnedValue =
-          if isNested
-          then addDescriptionsToMappings actualMappings."${name}" mappingDefinitions."${name}"
-          else {
-            inherit value;
-            inherit (mappingDefinitions."${name}") description;
-          };
-      in
-        returnedValue)
-      actualMappings;
-
-    mkSetBinding = binding: action:
-      mkBinding binding.value action binding.description;
-
-    mkSetExprBinding = binding: action:
-      mkExprBinding binding.value action binding.description;
-
-    mkSetLuaBinding = binding: action:
-      mkLuaBinding binding.value action binding.description;
-
-    pushDownDefault = attr: mapAttrs (_: mkDefault) attr;
-  };
-in
-  binds
+  pushDownDefault = attr: mapAttrs (_: mkDefault) attr;
+in {
+  inherit mkLuaBinding mkExprBinding mkBinding mkMappingOption addDescriptionsToMappings mkSetBinding mkSetExprBinding mkSetLuaBinding pushDownDefault;
+}
diff --git a/modules/neovim/mappings/config.nix b/modules/neovim/mappings/config.nix
index 28ebf08..365e124 100644
--- a/modules/neovim/mappings/config.nix
+++ b/modules/neovim/mappings/config.nix
@@ -8,45 +8,26 @@
   cfg = config.vim;
 in {
   config = {
-    vim.maps = {
-      normal = mkIf cfg.disableArrows {
-        "<up>" = {
-          action = "<nop>";
-
-          noremap = false;
-        };
-        "<down>" = {
-          action = "<nop>";
-
-          noremap = false;
-        };
-        "<left>" = {
-          action = "<nop>";
-          noremap = false;
-        };
-        "<right>" = {
-          action = "<nop>";
-          noremap = false;
-        };
+    vim.maps = mkIf cfg.disableArrows {
+      "<up>" = {
+        mode = ["n" "i"];
+        action = "<nop>";
+        noremap = false;
       };
-
-      insert = mkIf cfg.disableArrows {
-        "<up>" = {
-          action = "<nop>";
-          noremap = false;
-        };
-        "<down>" = {
-          action = "<nop>";
-          noremap = false;
-        };
-        "<left>" = {
-          action = "<nop>";
-          noremap = false;
-        };
-        "<right>" = {
-          action = "<nop>";
-          noremap = false;
-        };
+      "<down>" = {
+        mode = ["n" "i"];
+        action = "<nop>";
+        noremap = false;
+      };
+      "<left>" = {
+        mode = ["n" "i"];
+        action = "<nop>";
+        noremap = false;
+      };
+      "<right>" = {
+        mode = ["n" "i"];
+        action = "<nop>";
+        noremap = false;
       };
     };
   };
diff --git a/modules/neovim/mappings/options.nix b/modules/neovim/mappings/options.nix
index 3b1f263..dcf9cf4 100644
--- a/modules/neovim/mappings/options.nix
+++ b/modules/neovim/mappings/options.nix
@@ -1,96 +1,49 @@
 {lib, ...}: let
   inherit (lib.options) mkOption;
-  inherit (lib.types) bool str attrsOf nullOr submodule;
+  inherit (lib.types) either str listOf attrsOf nullOr submodule;
   inherit (lib.nvim.config) mkBool;
-  # Most of the keybindings code is highly inspired by pta2002/nixvim.
-  # Thank you!
-  mapConfigOptions = {
-    silent =
-      mkBool false
-      "Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
 
-    nowait =
-      mkBool false
-      "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
-
-    script =
-      mkBool false
-      "Equivalent to adding <script> to a map.";
-
-    expr =
-      mkBool false
-      "Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
-
-    unique =
-      mkBool false
-      "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
-
-    noremap =
-      mkBool true
-      "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
+  mapType = submodule {
+    mode = mkOption {
+      type = either str (listOf str);
+      description = ''
+        The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of `:map`.
 
+        See `:help map-modes` for a list of modes.
+      '';
+    };
     desc = mkOption {
       type = nullOr str;
       default = null;
       description = "A description of this keybind, to be shown in which-key, if you have it enabled.";
     };
-  };
 
-  mapOption = submodule {
-    options =
-      mapConfigOptions
-      // {
-        action = mkOption {
-          type = str;
-          description = "The action to execute.";
-        };
-
-        lua = mkOption {
-          type = bool;
-          description = ''
-            If true, `action` is considered to be lua code.
-            Thus, it will not be wrapped in `""`.
-          '';
-          default = false;
-        };
-      };
-  };
-
-  mapOptions = mode:
-    mkOption {
-      description = "Mappings for ${mode} mode";
-      type = attrsOf mapOption;
-      default = {};
+    action = mkOption {
+      type = str;
+      description = "The command to execute.";
     };
+    lua = mkBool false ''
+      If true, `action` is considered to be lua code.
+      Thus, it will not be wrapped in `""`.
+    '';
+
+    silent = mkBool true "Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
+    nowait = mkBool false "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
+    script = mkBool false "Equivalent to adding <script> to a map.";
+    expr = mkBool false "Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
+    unique = mkBool false "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
+    noremap = mkBool true "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
+  };
 in {
   options.vim = {
     maps = mkOption {
-      type = submodule {
-        options = {
-          normal = mapOptions "normal";
-          insert = mapOptions "insert";
-          select = mapOptions "select";
-          visual = mapOptions "visual and select";
-          terminal = mapOptions "terminal";
-          normalVisualOp = mapOptions "normal, visual, select and operator-pending (same as plain 'map')";
-
-          visualOnly = mapOptions "visual only";
-          operator = mapOptions "operator-pending";
-          insertCommand = mapOptions "insert and command-line";
-          lang = mapOptions "insert, command-line and lang-arg";
-          command = mapOptions "command-line";
-        };
-      };
+      type = attrsOf mapType;
       default = {};
-      description = ''
-        Custom keybindings for any mode.
-
-        For plain maps (e.g. just 'map' or 'remap') use `maps.normalVisualOp`.
-      '';
-
+      description = "Custom keybindings.";
       example = ''
         maps = {
-          normal."<leader>m" = {
+          "<leader>m" = {
+            mode = "n";
             silent = true;
             action = "<cmd>make<CR>";
           }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
diff --git a/modules/wrapper/rc/config.nix b/modules/wrapper/rc/config.nix
index be299f3..a3a31b6 100644
--- a/modules/wrapper/rc/config.nix
+++ b/modules/wrapper/rc/config.nix
@@ -3,85 +3,19 @@
   lib,
   ...
 }: let
-  inherit (builtins) map mapAttrs filter;
-  inherit (lib.options) mkOption;
-  inherit (lib.attrsets) filterAttrs getAttrs attrValues attrNames;
+  inherit (builtins) map mapAttrs filter attrsToList;
+  inherit (lib.attrsets) filterAttrs;
   inherit (lib.strings) concatLines concatMapStringsSep;
   inherit (lib.misc) mapAttrsFlatten;
   inherit (lib.trivial) showWarnings;
-  inherit (lib.types) str nullOr;
   inherit (lib.generators) mkLuaInline;
   inherit (lib.nvim.dag) entryAfter mkLuarcSection resolveDag entryAnywhere;
   inherit (lib.nvim.lua) toLuaObject;
-  inherit (lib.nvim.config) mkBool;
 
   cfg = config.vim;
-
-  # Most of the keybindings code is highly inspired by pta2002/nixvim.
-  # Thank you!
-  mapConfigOptions = {
-    silent =
-      mkBool false
-      "Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
-
-    nowait =
-      mkBool false
-      "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
-
-    script =
-      mkBool false
-      "Equivalent to adding <script> to a map.";
-
-    expr =
-      mkBool false
-      "Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
-
-    unique =
-      mkBool false
-      "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
-
-    noremap =
-      mkBool true
-      "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
-
-    desc = mkOption {
-      type = nullOr str;
-      default = null;
-      description = "A description of this keybind, to be shown in which-key, if you have it enabled.";
-    };
-  };
-
-  genMaps = mode: maps: let
-    /*
-    Take a user-defined action (string or attrs) and return the following attribute set:
-    {
-      action = (string) the actual action to map to this key
-      config = (attrs) the configuration options for this mapping (noremap, silent...)
-    }
-    */
-    normalizeAction = action: {
-      # Extract the values of the config options that have been explicitly set by the user
-      config =
-        filterAttrs (_: v: v != null)
-        (getAttrs (attrNames mapConfigOptions) action);
-      action =
-        if action.lua
-        then mkLuaInline action.action
-        else action.action;
-    };
-  in
-    attrValues (mapAttrs
-      (key: action: let
-        normalizedAction = normalizeAction action;
-      in {
-        inherit (normalizedAction) action config;
-        inherit key;
-        inherit mode;
-      })
-      maps);
 in {
   config = let
-    filterNonNull = attrs: filterAttrs (_: value: value != null) attrs;
+    filterNonNull = filterAttrs (_: value: value != null);
     globalsScript =
       mapAttrsFlatten (name: value: "vim.g.${name} = ${toLuaObject value}")
       (filterNonNull cfg.globals);
@@ -98,38 +32,21 @@ in {
       mapResult = result: concatLines (map mkLuarcSection result);
     };
 
-    toLuaBindings = mode: maps:
-      map (value: ''
-        vim.keymap.set(${toLuaObject mode}, ${toLuaObject value.key}, ${toLuaObject value.action}, ${toLuaObject value.config})
-      '') (genMaps mode maps);
+    getAction = keymap:
+      if keymap.lua
+      then mkLuaInline keymap.action
+      else keymap.action;
 
-    # I'm not sure if every one of these will work.
-    allmap = toLuaBindings "" config.vim.maps.normalVisualOp;
-    nmap = toLuaBindings "n" config.vim.maps.normal;
-    vmap = toLuaBindings "v" config.vim.maps.visual;
-    xmap = toLuaBindings "x" config.vim.maps.visualOnly;
-    smap = toLuaBindings "s" config.vim.maps.select;
-    imap = toLuaBindings "i" config.vim.maps.insert;
-    cmap = toLuaBindings "c" config.vim.maps.command;
-    tmap = toLuaBindings "t" config.vim.maps.terminal;
-    lmap = toLuaBindings "l" config.vim.maps.lang;
-    omap = toLuaBindings "o" config.vim.maps.operator;
-    icmap = toLuaBindings "ic" config.vim.maps.insertCommand;
+    getOpts = keymap: {
+      inherit (keymap) silent nowait script expr unique noremap;
+    };
 
-    maps = [
-      nmap
-      imap
-      vmap
-      xmap
-      smap
-      cmap
-      omap
-      tmap
-      lmap
-      icmap
-      allmap
-    ];
-    mappings = concatLines (map concatLines maps);
+    toLuaKeymap = {
+      name,
+      value,
+    }: "vim.keymap.set(${toLuaObject value.mode}, ${toLuaObject name}, ${toLuaObject (getAction value)}, ${toLuaObject (getOpts value)})";
+
+    keymaps = concatLines (map toLuaKeymap (attrsToList (filterNonNull config.maps)));
   in {
     vim = {
       luaConfigRC = {
@@ -137,7 +54,7 @@ in {
         # basic, theme
         pluginConfigs = entryAfter ["theme"] pluginConfigs;
         extraPluginConfigs = entryAfter ["pluginConfigs"] extraPluginConfigs;
-        mappings = entryAfter ["extraPluginConfigs"] mappings;
+        mappings = entryAfter ["extraPluginConfigs"] keymaps;
       };
 
       builtLuaConfigRC = let

From 2fc7dc798b9fc1cc307591deb977605de18f5000 Mon Sep 17 00:00:00 2001
From: Ching Pei Yang <59727193+horriblename@users.noreply.github.com>
Date: Tue, 13 Aug 2024 00:27:05 +0200
Subject: [PATCH 2/3] Re-add old maps API (#356)

* wrapper: fix wrong import source

* wrapper: fix typo

* Revert "lib/binds: improve code, adjust functions to new api"

This reverts commit 6cb57e1d266e8d1f40bc5af1e691a65d320f8a35.

* mappings: re-add legacy vim.maps API

* mappings: fix wrong submodule syntax

* docs: fix missing section id
---
 docs/release-notes/rl-0.7.md        |   4 +-
 lib/binds.nix                       | 121 ++++++++++++++--------------
 modules/neovim/mappings/options.nix |  73 ++++++++++++++---
 modules/wrapper/rc/config.nix       |  35 +++++++-
 4 files changed, 156 insertions(+), 77 deletions(-)

diff --git a/docs/release-notes/rl-0.7.md b/docs/release-notes/rl-0.7.md
index e0dabdf..51e05c9 100644
--- a/docs/release-notes/rl-0.7.md
+++ b/docs/release-notes/rl-0.7.md
@@ -4,7 +4,7 @@ Release notes for release 0.7
 
 ## Breaking Changes and Migration Guide {#sec-breaking-changes-and-migration-guide-0-7}
 
-### `vim.configRC` removed
+### `vim.configRC` removed {#sec-vim-configrc-removed}
 
 In v0.7 we are removing `vim.configRC` in favor of making `vim.luaConfigRC` the
 top-level DAG, and thereby making the entire configuration Lua based. This
@@ -26,7 +26,7 @@ making good use of its extensive Lua API. Additionally, Vimscript is slow and
 brings unnecessary performance overhead while working with different
 configuration formats.
 
-### `vim.maps` rewrite
+### `vim.maps` rewrite {#sec-vim-maps-rewrite}
 
 Instead of specifying map modes using submodules (eg.: `vim.maps.normal`), a new
 `mode` option has mode has been introduced. It can be either a string, or a list
diff --git a/lib/binds.nix b/lib/binds.nix
index a8fbf5f..8c9e9a6 100644
--- a/lib/binds.nix
+++ b/lib/binds.nix
@@ -4,68 +4,69 @@
   inherit (lib.types) nullOr str;
   inherit (lib.attrsets) isAttrs mapAttrs;
 
-  mkLuaBinding = mode: key: action: desc:
-    mkIf (key != null) {
-      ${key} = {
-        inherit mode action desc;
-        lua = true;
-        silent = true;
-      };
-    };
-
-  mkExprBinding = mode: key: action: desc:
-    mkIf (key != null) {
-      ${key} = {
-        inherit mode action desc;
-        lua = true;
-        silent = true;
-        expr = true;
-      };
-    };
-
-  mkBinding = mode: key: action: desc:
-    mkIf (key != null) {
-      ${key} = {
-        inherit mode action desc;
-        silent = true;
-      };
-    };
-
-  mkMappingOption = description: default:
-    mkOption {
-      type = nullOr str;
-      inherit default description;
-    };
-
-  # Utility function that takes two attrsets:
-  # { someKey = "some_value" } and
-  # { someKey = { description = "Some Description"; }; }
-  # and merges them into
-  # { someKey = { value = "some_value"; description = "Some Description"; }; }
-  addDescriptionsToMappings = actualMappings: mappingDefinitions:
-    mapAttrs (name: value: let
-      isNested = isAttrs value;
-      returnedValue =
-        if isNested
-        then addDescriptionsToMappings actualMappings.${name} mappingDefinitions.${name}
-        else {
-          inherit value;
-          inherit (mappingDefinitions.${name}) description;
+  binds = rec {
+    mkLuaBinding = key: action: desc:
+      mkIf (key != null) {
+        "${key}" = {
+          inherit action desc;
+          lua = true;
+          silent = true;
         };
-    in
-      returnedValue)
-    actualMappings;
+      };
 
-  mkSetBinding = mode: binding: action:
-    mkBinding mode binding.value action binding.description;
+    mkExprBinding = key: action: desc:
+      mkIf (key != null) {
+        "${key}" = {
+          inherit action desc;
+          lua = true;
+          silent = true;
+          expr = true;
+        };
+      };
 
-  mkSetExprBinding = mode: binding: action:
-    mkExprBinding mode binding.value action binding.description;
+    mkBinding = key: action: desc:
+      mkIf (key != null) {
+        "${key}" = {
+          inherit action desc;
+          silent = true;
+        };
+      };
 
-  mkSetLuaBinding = mode: binding: action:
-    mkLuaBinding mode binding.value action binding.description;
+    mkMappingOption = description: default:
+      mkOption {
+        type = nullOr str;
+        inherit default description;
+      };
 
-  pushDownDefault = attr: mapAttrs (_: mkDefault) attr;
-in {
-  inherit mkLuaBinding mkExprBinding mkBinding mkMappingOption addDescriptionsToMappings mkSetBinding mkSetExprBinding mkSetLuaBinding pushDownDefault;
-}
+    # Utility function that takes two attrsets:
+    # { someKey = "some_value" } and
+    # { someKey = { description = "Some Description"; }; }
+    # and merges them into
+    # { someKey = { value = "some_value"; description = "Some Description"; }; }
+    addDescriptionsToMappings = actualMappings: mappingDefinitions:
+      mapAttrs (name: value: let
+        isNested = isAttrs value;
+        returnedValue =
+          if isNested
+          then addDescriptionsToMappings actualMappings."${name}" mappingDefinitions."${name}"
+          else {
+            inherit value;
+            inherit (mappingDefinitions."${name}") description;
+          };
+      in
+        returnedValue)
+      actualMappings;
+
+    mkSetBinding = binding: action:
+      mkBinding binding.value action binding.description;
+
+    mkSetExprBinding = binding: action:
+      mkExprBinding binding.value action binding.description;
+
+    mkSetLuaBinding = binding: action:
+      mkLuaBinding binding.value action binding.description;
+
+    pushDownDefault = attr: mapAttrs (_: mkDefault) attr;
+  };
+in
+  binds
diff --git a/modules/neovim/mappings/options.nix b/modules/neovim/mappings/options.nix
index dcf9cf4..522079e 100644
--- a/modules/neovim/mappings/options.nix
+++ b/modules/neovim/mappings/options.nix
@@ -1,17 +1,9 @@
 {lib, ...}: let
   inherit (lib.options) mkOption;
-  inherit (lib.types) either str listOf attrsOf nullOr submodule;
+  inherit (lib.types) either str listOf attrsOf nullOr submodule bool;
   inherit (lib.nvim.config) mkBool;
 
-  mapType = submodule {
-    mode = mkOption {
-      type = either str (listOf str);
-      description = ''
-        The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of `:map`.
-
-        See `:help map-modes` for a list of modes.
-      '';
-    };
+  mapConfigOptions = {
     desc = mkOption {
       type = nullOr str;
       default = null;
@@ -34,10 +26,69 @@
     unique = mkBool false "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
     noremap = mkBool true "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
   };
+
+  mapType = submodule {
+    options =
+      mapConfigOptions
+      // {
+        mode = mkOption {
+          type = either str (listOf str);
+          description = ''
+            The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of `:map`.
+
+            See `:help map-modes` for a list of modes.
+          '';
+        };
+      };
+  };
+
+  # legacy stuff
+  mapOption = submodule {
+    options =
+      mapConfigOptions
+      // {
+        action = mkOption {
+          type = str;
+          description = "The action to execute.";
+        };
+
+        lua = mkOption {
+          type = bool;
+          description = ''
+            If true, `action` is considered to be lua code.
+            Thus, it will not be wrapped in `""`.
+          '';
+          default = false;
+        };
+      };
+  };
+
+  mapOptions = mode:
+    mkOption {
+      description = "Mappings for ${mode} mode";
+      type = attrsOf mapOption;
+      default = {};
+    };
 in {
   options.vim = {
     maps = mkOption {
-      type = attrsOf mapType;
+      type = submodule {
+        freeformType = attrsOf mapType;
+        options = {
+          normal = mapOptions "normal";
+          insert = mapOptions "insert";
+          select = mapOptions "select";
+          visual = mapOptions "visual and select";
+          terminal = mapOptions "terminal";
+          normalVisualOp = mapOptions "normal, visual, select and operator-pending (same as plain 'map')";
+
+          visualOnly = mapOptions "visual only";
+          operator = mapOptions "operator-pending";
+          insertCommand = mapOptions "insert and command-line";
+          lang = mapOptions "insert, command-line and lang-arg";
+          command = mapOptions "command-line";
+        };
+      };
       default = {};
       description = "Custom keybindings.";
       example = ''
diff --git a/modules/wrapper/rc/config.nix b/modules/wrapper/rc/config.nix
index 7457d45..f4c100d 100644
--- a/modules/wrapper/rc/config.nix
+++ b/modules/wrapper/rc/config.nix
@@ -3,9 +3,8 @@
   lib,
   ...
 }: let
-  inherit (builtins) map mapAttrs filter;
-  inherit (lib.options) mkOption;
-  inherit (lib.attrsets) mapAttrsToList filterAttrs getAttrs attrValues attrNames;
+  inherit (builtins) map mapAttrs filter removeAttrs attrNames;
+  inherit (lib.attrsets) mapAttrsToList filterAttrs attrsToList;
   inherit (lib.strings) concatLines concatMapStringsSep;
   inherit (lib.trivial) showWarnings;
   inherit (lib.generators) mkLuaInline;
@@ -46,7 +45,35 @@ in {
       value,
     }: "vim.keymap.set(${toLuaObject value.mode}, ${toLuaObject name}, ${toLuaObject (getAction value)}, ${toLuaObject (getOpts value)})";
 
-    keymaps = concatLines (map toLuaKeymap (attrsToList (filterNonNull config.maps)));
+    namedModes = {
+      "normal" = ["n"];
+      "insert" = ["i"];
+      "select" = ["s"];
+      "visual" = ["v"];
+      "terminal" = ["t"];
+      "normalVisualOp" = ["n" "v" "o"];
+      "visualOnly" = ["n" "x"];
+      "operator" = ["o"];
+      "insertCommand" = ["i" "c"];
+      "lang" = ["l"];
+      "command" = ["c"];
+    };
+
+    maps =
+      removeAttrs cfg.maps (attrNames namedModes)
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.normal;}) cfg.maps.normal
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.insert;}) cfg.maps.insert
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.select;}) cfg.maps.select
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.visual;}) cfg.maps.visual
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.terminal;}) cfg.maps.terminal
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.normalVisualOp;}) cfg.maps.normalVisualOp
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.visualOnly;}) cfg.maps.visualOnly
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.operator;}) cfg.maps.operator
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.insertCommand;}) cfg.maps.insertCommand
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.lang;}) cfg.maps.lang
+      // mapAttrs (_: legacyMap: legacyMap // {mode = namedModes.command;}) cfg.maps.command;
+
+    keymaps = concatLines (map toLuaKeymap (attrsToList (filterNonNull maps)));
   in {
     vim = {
       luaConfigRC = {

From e40cce5653d180cf6ed7db8feeea0e87b4eb76b3 Mon Sep 17 00:00:00 2001
From: Ching Pei Yang <59727193+horriblename@users.noreply.github.com>
Date: Sat, 17 Aug 2024 13:08:47 +0200
Subject: [PATCH 3/3] fix: map descriptions (#358)

* remove unused

* maps: fix missing description
---
 modules/neovim/mappings/options.nix | 18 +-----------------
 modules/wrapper/rc/config.nix       |  2 +-
 2 files changed, 2 insertions(+), 18 deletions(-)

diff --git a/modules/neovim/mappings/options.nix b/modules/neovim/mappings/options.nix
index 522079e..f422991 100644
--- a/modules/neovim/mappings/options.nix
+++ b/modules/neovim/mappings/options.nix
@@ -44,23 +44,7 @@
 
   # legacy stuff
   mapOption = submodule {
-    options =
-      mapConfigOptions
-      // {
-        action = mkOption {
-          type = str;
-          description = "The action to execute.";
-        };
-
-        lua = mkOption {
-          type = bool;
-          description = ''
-            If true, `action` is considered to be lua code.
-            Thus, it will not be wrapped in `""`.
-          '';
-          default = false;
-        };
-      };
+    options = mapConfigOptions;
   };
 
   mapOptions = mode:
diff --git a/modules/wrapper/rc/config.nix b/modules/wrapper/rc/config.nix
index f4c100d..b3fd2e4 100644
--- a/modules/wrapper/rc/config.nix
+++ b/modules/wrapper/rc/config.nix
@@ -37,7 +37,7 @@ in {
       else keymap.action;
 
     getOpts = keymap: {
-      inherit (keymap) silent nowait script expr unique noremap;
+      inherit (keymap) desc silent nowait script expr unique noremap;
     };
 
     toLuaKeymap = {