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

@@ -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

lib/binds.nix

@@ -4,69 +4,68 @@
   inherit (lib.types) nullOr str;
   inherit (lib.attrsets) isAttrs mapAttrs;
 
-  binds = rec {
+  mkLuaBinding = mode: key: action: desc:
-    mkLuaBinding = key: action: desc:
+    mkIf (key != null) {
-      mkIf (key != null) {
+      ${key} = {
-        "${key}" = {
+        inherit mode action desc;
-          inherit action desc;
+        lua = true;
-          lua = true;
+        silent = 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:
+  mkSetBinding = mode: binding: action:
-      mkIf (key != null) {
+    mkBinding mode binding.value action binding.description;
-        "${key}" = {
-          inherit action desc;
-          lua = true;
-          silent = true;
-          expr = true;
-        };
-      };
 
-    mkBinding = key: action: desc:
+  mkSetExprBinding = mode: binding: action:
-      mkIf (key != null) {
+    mkExprBinding mode binding.value action binding.description;
-        "${key}" = {
-          inherit action desc;
-          silent = true;
-        };
-      };
 
-    mkMappingOption = description: default:
+  mkSetLuaBinding = mode: binding: action:
-      mkOption {
+    mkLuaBinding mode binding.value action binding.description;
-        type = nullOr str;
-        inherit default description;
-      };
 
-    # Utility function that takes two attrsets:
+  pushDownDefault = attr: mapAttrs (_: mkDefault) attr;
-    # { someKey = "some_value" } and
+in {
-    # { someKey = { description = "Some Description"; }; }
+  inherit mkLuaBinding mkExprBinding mkBinding mkMappingOption addDescriptionsToMappings mkSetBinding mkSetExprBinding mkSetLuaBinding pushDownDefault;
-    # 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

modules/neovim/mappings/config.nix

@@ -8,45 +8,26 @@
   cfg = config.vim;
 in {
   config = {
-    vim.maps = {
+    vim.maps = mkIf cfg.disableArrows {
-      normal = mkIf cfg.disableArrows {
+      "<up>" = {
-        "<up>" = {
+        mode = ["n" "i"];
-          action = "<nop>";
+        action = "<nop>";
-
+        noremap = false;
-          noremap = false;
-        };
-        "<down>" = {
-          action = "<nop>";
-
-          noremap = false;
-        };
-        "<left>" = {
-          action = "<nop>";
-          noremap = false;
-        };
-        "<right>" = {
-          action = "<nop>";
-          noremap = false;
-        };
       };
-
+      "<down>" = {
-      insert = mkIf cfg.disableArrows {
+        mode = ["n" "i"];
-        "<up>" = {
+        action = "<nop>";
-          action = "<nop>";
+        noremap = false;
-          noremap = false;
+      };
-        };
+      "<left>" = {
-        "<down>" = {
+        mode = ["n" "i"];
-          action = "<nop>";
+        action = "<nop>";
-          noremap = false;
+        noremap = false;
-        };
+      };
-        "<left>" = {
+      "<right>" = {
-          action = "<nop>";
+        mode = ["n" "i"];
-          noremap = false;
+        action = "<nop>";
-        };
+        noremap = false;
-        "<right>" = {
-          action = "<nop>";
-          noremap = false;
-        };
       };
     };
   };

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 =
+  mapType = submodule {
-      mkBool false
+    mode = mkOption {
-      "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
+      type = either str (listOf str);
-
+      description = ''
-    script =
+        The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of `:map`.
-      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.";
 
+        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 {
+    action = mkOption {
-    options =
+      type = str;
-      mapConfigOptions
+      description = "The command to execute.";
-      // {
-        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 = {};
     };
+    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 {
+      type = 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 = ''
+      description = "Custom keybindings.";
-        Custom keybindings for any mode.
-
-        For plain maps (e.g. just 'map' or 'remap') use `maps.normalVisualOp`.
-      '';
-
       example = ''
         maps = {
-          normal."<leader>m" = {
+          "<leader>m" = {
+            mode = "n";
             silent = true;
             action = "<cmd>make<CR>";
           }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>

modules/wrapper/rc/config.nix

@@ -3,84 +3,18 @@
   lib,
   ...
 }: let
-  inherit (builtins) map mapAttrs filter;
+  inherit (builtins) map mapAttrs filter attrsToList;
-  inherit (lib.options) mkOption;
+  inherit (lib.attrsets) mapAttrsToList filterAttrs;
-  inherit (lib.attrsets) mapAttrsToList filterAttrs getAttrs attrValues attrNames;
   inherit (lib.strings) concatLines concatMapStringsSep;
   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 =
       mapAttrsToList (name: value: "vim.g.${name} = ${toLuaObject value}")
       (filterNonNull cfg.globals);
@@ -97,38 +31,21 @@ in {
       mapResult = result: concatLines (map mkLuarcSection result);
     };
 
-    toLuaBindings = mode: maps:
+    getAction = keymap:
-      map (value: ''
+      if keymap.lua
-        vim.keymap.set(${toLuaObject mode}, ${toLuaObject value.key}, ${toLuaObject value.action}, ${toLuaObject value.config})
+      then mkLuaInline keymap.action
-      '') (genMaps mode maps);
+      else keymap.action;
 
-    # I'm not sure if every one of these will work.
+    getOpts = keymap: {
-    allmap = toLuaBindings "" config.vim.maps.normalVisualOp;
+      inherit (keymap) silent nowait script expr unique noremap;
-    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;
 
-    maps = [
+    toLuaKeymap = {
-      nmap
+      name,
-      imap
+      value,
-      vmap
+    }: "vim.keymap.set(${toLuaObject value.mode}, ${toLuaObject name}, ${toLuaObject (getAction value)}, ${toLuaObject (getOpts value)})";
-      xmap
+
-      smap
+    keymaps = concatLines (map toLuaKeymap (attrsToList (filterNonNull config.maps)));
-      cmap
-      omap
-      tmap
-      lmap
-      icmap
-      allmap
-    ];
-    mappings = concatLines (map concatLines maps);
   in {
     vim = {
       luaConfigRC = {
@@ -136,7 +53,7 @@ in {
         # basic, theme
         pluginConfigs = entryAfter ["theme"] pluginConfigs;
         extraPluginConfigs = entryAfter ["pluginConfigs"] extraPluginConfigs;
-        mappings = entryAfter ["extraPluginConfigs"] mappings;
+        mappings = entryAfter ["extraPluginConfigs"] keymaps;
       };
 
       builtLuaConfigRC = let