Merge f6500bbd05 into fd65c83956

docs/release-notes/rl-0.7.md

@@ -4,8 +4,6 @@ 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}
-
 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:
@@ -26,28 +24,6 @@ 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}
-
-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):
@@ -138,8 +114,6 @@ vim.maps."<leader>m" = {
     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
@@ -169,10 +143,10 @@ vim.maps."<leader>m" = {
 - Add [neo-tree.nvim] as an alternative file-tree plugin. It will be available
   under `vim.filetree.neo-tree`, similar to nvimtree.
 
-- Add `nvf-print-config` & `nvf-print-config-path` helper scripts to Neovim
+- Add `print-nvf-config` & `print-nvf-config-path` helper scripts to Neovim
   closure. Both of those scripts have been automatically added to your PATH upon
   using neovimConfig or `programs.nvf.enable`.
-  - `nvf-print-config` will display your `init.lua`, in full.
+  - `print-nvf-config` will display your `init.lua`, in full.
-  - `nvf-print-config-path` will display the path to _a clone_ of your
+  - `print-nvf-config-path` will display the path to _a clone_ of your
     `init.lua`. This is not the path used by the Neovim wrapper, but an
     identical clone.

flake.lock

@@ -69,11 +69,11 @@
     },
     "mnw": {
       "locked": {
-        "lastModified": 1723419050,
+        "lastModified": 1722191188,
-        "narHash": "sha256-Eb8jBUgHwpte+bGsqeXNbKMBfZaDB7RiPQwyb1vzJK8=",
+        "narHash": "sha256-YF//iMALbrd2Ni9aju7w8NniH16Qz6RFTRD6md5UkDc=",
         "owner": "Gerg-L",
         "repo": "mnw",
-        "rev": "e625f5965567f16102bc52897c7600dcde53c6c3",
+        "rev": "c7b289f3f5a31b6e744be37d83fc231816621231",
         "type": "github"
       },
       "original": {
@@ -971,22 +971,6 @@
         "type": "github"
       }
     },
-    "plugin-new-file-template-nvim": {
-      "flake": false,
-      "locked": {
-        "lastModified": 1721518222,
-        "narHash": "sha256-g0IjJrHRXw7U9goVLzVYUyHBSsDZGHMpi3YZPhg64zA=",
-        "owner": "otavioschwanck",
-        "repo": "new-file-template.nvim",
-        "rev": "6ac66669dbf2dc5cdee184a4fe76d22465ca67e8",
-        "type": "github"
-      },
-      "original": {
-        "owner": "otavioschwanck",
-        "repo": "new-file-template.nvim",
-        "type": "github"
-      }
-    },
     "plugin-noice-nvim": {
       "flake": false,
       "locked": {
@@ -1912,7 +1896,6 @@
         "plugin-neo-tree-nvim": "plugin-neo-tree-nvim",
         "plugin-neocord": "plugin-neocord",
         "plugin-neodev-nvim": "plugin-neodev-nvim",
-        "plugin-new-file-template-nvim": "plugin-new-file-template-nvim",
         "plugin-noice-nvim": "plugin-noice-nvim",
         "plugin-none-ls": "plugin-none-ls",
         "plugin-nui-nvim": "plugin-nui-nvim",

modules/default.nix

@@ -7,72 +7,91 @@ inputs: {
   extraModules ? [],
 }: let
   inherit (pkgs) vimPlugins;
+  inherit (pkgs.vimUtils) buildVimPlugin;
   inherit (lib.strings) isString toString;
   inherit (lib.lists) filter map concatLists;
+  inherit (lib.attrsets) recursiveUpdate getAttr;
+  inherit (lib.asserts) assertMsg;
 
   # import modules.nix with `check`, `pkgs` and `lib` as arguments
   # check can be disabled while calling this file is called
   # to avoid checking in all modules
-  nvimModules = import ./modules.nix {inherit pkgs check lib;};
+  nvimModules = import ./modules.nix {
+    inherit pkgs check lib;
+  };
 
   # evaluate the extended library with the modules
   # optionally with any additional modules passed by the user
   module = lib.evalModules {
-    specialArgs = extraSpecialArgs // {modulesPath = toString ./.;};
+    specialArgs = recursiveUpdate {modulesPath = toString ./.;} extraSpecialArgs;
     modules = concatLists [[configuration] nvimModules extraModules];
   };
 
   # alias to the internal configuration
   vimOptions = module.config.vim;
 
-  noBuildPlug = {pname, ...} @ attrs: let
-    src = inputs."plugin-${attrs.pname}";
-  in
-    {
-      version = src.shortRev or src.shortDirtyRev or "dirty";
-      outPath = src;
-      passthru.vimPlugin = false;
-    }
-    // attrs;
-
   # build a vim plugin with the given name and arguments
   # if the plugin is nvim-treesitter, warn the user to use buildTreesitterPlug
   # instead
-  buildPlug = attrs: let
+  buildPlug = {pname, ...} @ attrs: let
-    src = inputs."plugin-${attrs.pname}";
+    src = getAttr ("plugin-" + pname) inputs;
   in
-    pkgs.vimUtils.buildVimPlugin (
+    pkgs.stdenvNoCC.mkDerivation ({
-      {
-        version = src.shortRev or src.shortDirtyRev or "dirty";
         inherit src;
+        version = src.shortRev or src.shortDirtyRev or "dirty";
+        installPhase = ''
+          runHook preInstall
+
+          mkdir -p $out
+          cp -r . $out
+
+          runHook postInstall
+        '';
       }
-      // attrs
+      // attrs);
-    );
+
+  noBuildPlug = {pname, ...} @ attrs: let
+    input = getAttr ("plugin-" + pname) inputs;
+  in
+    {
+      version = input.shortRev or input.shortDirtyRev or "dirty";
+      outPath = getAttr ("plugin-" + pname) inputs;
+    }
+    // attrs;
 
   buildTreesitterPlug = grammars: vimPlugins.nvim-treesitter.withPlugins (_: grammars);
 
-  pluginBuilders = {
-    nvim-treesitter = buildTreesitterPlug vimOptions.treesitter.grammars;
-    flutter-tools-patched = buildPlug {
-      pname = "flutter-tools";
-      patches = [../patches/flutter-tools.patch];
-    };
-  };
-
   buildConfigPlugins = plugins:
-    map (
+    map
-      plug:
+    (plug: (
-        if (isString plug)
+      if (isString plug)
-        then pluginBuilders.${plug} or (noBuildPlug {pname = plug;})
+      then
-        else plug
+        (
-    ) (filter (f: f != null) plugins);
+          if (plug == "nvim-treesitter")
+          then (buildTreesitterPlug vimOptions.treesitter.grammars)
+          else if (plug == "flutter-tools-patched")
+          then
+            (
+              buildPlug
+              {
+                pname = "flutter-tools";
+                patches = [../patches/flutter-tools.patch];
+              }
+            )
+          else noBuildPlug {pname = plug;}
+        )
+      else plug
+    ))
+    (filter
+      (f: f != null)
+      plugins);
 
   # built (or "normalized") plugins that are modified
   builtStartPlugins = buildConfigPlugins vimOptions.startPlugins;
   builtOptPlugins = map (package: package // {optional = true;}) (buildConfigPlugins vimOptions.optPlugins);
 
   # additional Lua and Python3 packages, mapped to their respective functions
-  # to conform to the format mnw expects. end user should
+  # to conform to the format makeNeovimConfig expects. end user should
   # only ever need to pass a list of packages, which are modified
   # here
   extraLuaPackages = ps: map (x: ps.${x}) vimOptions.luaPackages;
@@ -82,7 +101,7 @@ inputs: {
   # generate a wrapped Neovim package.
   neovim-wrapped = inputs.mnw.lib.wrap pkgs {
     neovim = vimOptions.package;
-    plugins = builtStartPlugins ++ builtOptPlugins;
+    plugins = concatLists [builtStartPlugins builtOptPlugins];
     appName = "nvf";
     extraBinPath = vimOptions.extraPackages;
     initLua = vimOptions.builtLuaConfigRC;
@@ -92,11 +111,20 @@ inputs: {
     inherit extraLuaPackages extraPython3Packages;
   };
 
-  dummyInit = pkgs.writeText "nvf-init.lua" vimOptions.builtLuaConfigRC;
   # Additional helper scripts for printing and displaying nvf configuration
   # in your commandline.
-  printConfig = pkgs.writers.writeDashBin "nvf-print-config" "cat ${dummyInit}";
+  printConfig = pkgs.writers.writeDashBin "print-nvf-config" ''
-  printConfigPath = pkgs.writers.writeDashBin "nvf-print-config-path" "echo -n ${dummyInit}";
+    cat << EOF
+      ${vimOptions.builtLuaConfigRC}
+    EOF
+  '';
+
+  printConfigPath = pkgs.writers.writeDashBin "print-nvf-config-path" ''
+    realpath ${pkgs.writeTextFile {
+      name = "nvf-init.lua";
+      text = vimOptions.builtLuaConfigRC;
+    }}
+  '';
 in {
   inherit (module) options config;
   inherit (module._module.args) pkgs;
@@ -106,7 +134,7 @@ in {
   neovim = pkgs.symlinkJoin {
     name = "nvf-with-helpers";
     paths = [neovim-wrapped printConfig printConfigPath];
-    postBuild = "echo Helpers added";
+    postBuild = "echo helpers added";
 
     meta = {
       description = "Wrapped version of Neovim with additional helper scripts";

modules/neovim/mappings/config.nix

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

modules/neovim/mappings/options.nix

@@ -1,48 +1,41 @@
 {lib, ...}: let
   inherit (lib.options) mkOption;
-  inherit (lib.types) either str listOf attrsOf nullOr submodule bool;
+  inherit (lib.types) bool str 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.";
+
     desc = mkOption {
       type = nullOr str;
       default = null;
       description = "A description of this keybind, to be shown in which-key, if you have it enabled.";
     };
-
-    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.";
   };
 
-  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
@@ -73,7 +66,6 @@ in {
   options.vim = {
     maps = mkOption {
       type = submodule {
-        freeformType = attrsOf mapType;
         options = {
           normal = mapOptions "normal";
           insert = mapOptions "insert";
@@ -90,11 +82,15 @@ in {
         };
       };
       default = {};
-      description = "Custom keybindings.";
+      description = ''
+        Custom keybindings for any mode.
+
+        For plain maps (e.g. just 'map' or 'remap') use `maps.normalVisualOp`.
+      '';
+
       example = ''
         maps = {
-          "<leader>m" = {
+          normal."<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,20 +3,87 @@
   lib,
   ...
 }: let
-  inherit (builtins) map mapAttrs filter removeAttrs attrNames;
+  inherit (builtins) map mapAttrs filter;
-  inherit (lib.attrsets) mapAttrsToList filterAttrs attrsToList;
+  inherit (lib.options) mkOption;
+  inherit (lib.attrsets) filterAttrs getAttrs attrValues attrNames;
   inherit (lib.strings) concatLines concatMapStringsSep optionalString;
+  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 = filterAttrs (_: value: value != null);
+    filterNonNull = attrs: filterAttrs (_: value: value != null) attrs;
     globalsScript =
-      mapAttrsToList (name: value: "vim.g.${name} = ${toLuaObject value}")
+      mapAttrsFlatten (name: value: "vim.g.${name} = ${toLuaObject value}")
       (filterNonNull cfg.globals);
 
     extraPluginConfigs = resolveDag {
@@ -31,49 +98,38 @@ in {
       mapResult = result: concatLines (map mkLuarcSection result);
     };
 
-    getAction = keymap:
+    toLuaBindings = mode: maps:
-      if keymap.lua
+      map (value: ''
-      then mkLuaInline keymap.action
+        vim.keymap.set(${toLuaObject mode}, ${toLuaObject value.key}, ${toLuaObject value.action}, ${toLuaObject value.config})
-      else keymap.action;
+      '') (genMaps mode maps);
 
-    getOpts = keymap: {
+    # I'm not sure if every one of these will work.
-      inherit (keymap) silent nowait script expr unique noremap;
+    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;
 
-    toLuaKeymap = {
+    maps = [
-      name,
+      nmap
-      value,
+      imap
-    }: "vim.keymap.set(${toLuaObject value.mode}, ${toLuaObject name}, ${toLuaObject (getAction value)}, ${toLuaObject (getOpts value)})";
+      vmap
-
+      xmap
-    namedModes = {
+      smap
-      "normal" = ["n"];
+      cmap
-      "insert" = ["i"];
+      omap
-      "select" = ["s"];
+      tmap
-      "visual" = ["v"];
+      lmap
-      "terminal" = ["t"];
+      icmap
-      "normalVisualOp" = ["n" "v" "o"];
+      allmap
-      "visualOnly" = ["n" "x"];
+    ];
-      "operator" = ["o"];
+    mappings = concatLines (map concatLines maps);
-      "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 = {
@@ -81,7 +137,7 @@ in {
         # basic, theme
         pluginConfigs = entryAfter ["theme"] pluginConfigs;
         extraPluginConfigs = entryAfter ["pluginConfigs"] extraPluginConfigs;
-        mappings = entryAfter ["extraPluginConfigs"] keymaps;
+        mappings = entryAfter ["extraPluginConfigs"] mappings;
         # FIXME: put this somewhere less stupid
         footer = entryAfter ["mappings"] (optionalString config.vim.lazy.enable "require('lzn-auto-require.loader').register_loader()");
       };