add TODO

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 {#sec-vim-configrc-removed}
+### `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 {#sec-vim-maps-rewrite}
+### `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

lib/binds.nix

@@ -5,39 +5,66 @@
   inherit (lib.attrsets) isAttrs mapAttrs;
   inherit (lib.generators) mkLuaInline;
 
-  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 = key: action: desc:
+  mkExprBinding = mode: key: action: desc:
-      mkIf (key != null) {
+    mkIf (key != null) {
-        "${key}" = {
+      ${key} = {
-          inherit action desc;
+        inherit mode action desc;
-          lua = true;
+        lua = true;
-          silent = true;
+        silent = true;
-          expr = true;
+        expr = true;
-        };
       };
+    };
 
-    mkBinding = key: action: desc:
+  mkBinding = mode: key: action: desc:
-      mkIf (key != null) {
+    mkIf (key != null) {
-        "${key}" = {
+      ${key} = {
-          inherit action desc;
+        inherit mode action desc;
-          silent = true;
+        silent = true;
-        };
       };
+    };
 
-    mkMappingOption = description: default:
+  mkMappingOption = description: default:
-      mkOption {
+    mkOption {
-        type = nullOr str;
+      type = nullOr str;
-        inherit default description;
+      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;
+
+  mkSetBinding = mode: binding: action:
+    mkBinding mode binding.value action binding.description;
+
+  mkSetExprBinding = mode: binding: action:
+    mkExprBinding mode binding.value action binding.description;
+
+  mkSetLuaBinding = mode: binding: action:
+    mkLuaBinding mode binding.value action binding.description;
 
     # Utility function that takes two attrsets:
     # { someKey = "some_value" } and

modules/neovim/mappings/options.nix

@@ -1,9 +1,17 @@
 {lib, ...}: let
   inherit (lib.options) mkOption;
-  inherit (lib.types) either str listOf attrsOf nullOr submodule bool;
+  inherit (lib.types) either str listOf attrsOf nullOr submodule;
   inherit (lib.nvim.config) mkBool;
 
-  mapConfigOptions = {
+  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;
@@ -26,69 +34,10 @@
     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 = submodule {
+      type = attrsOf mapType;
-        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 = ''

modules/wrapper/rc/config.nix

@@ -3,7 +3,7 @@
   lib,
   ...
 }: let
-  inherit (builtins) map mapAttrs filter removeAttrs attrNames;
+  inherit (builtins) map mapAttrs filter;
   inherit (lib.attrsets) mapAttrsToList filterAttrs attrsToList;
   inherit (lib.strings) concatLines concatMapStringsSep optionalString;
   inherit (lib.trivial) showWarnings;
@@ -45,35 +45,7 @@ in {
       value,
     }: "vim.keymap.set(${toLuaObject value.mode}, ${toLuaObject name}, ${toLuaObject (getAction value)}, ${toLuaObject (getOpts value)})";
 
-    namedModes = {
+    keymaps = concatLines (map toLuaKeymap (attrsToList (filterNonNull config.maps)));
-      "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 = {