Merge 2b3c0cde23 into ef413736e9

* doc: fix formatting

* docs: update keymaps section

docs/manual/hacking/keybinds.md

@@ -7,37 +7,26 @@ section contains a general overview to how you may utilize said functions.
 
 ## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings}
 
-To set a mapping, you should define it in `vim.maps.<<mode>>`.
-The available modes are:
-
-- normal
-- insert
-- select
-- visual
-- terminal
-- normalVisualOp
-- visualOnly
-- operator
-- insertCommand
-- lang
-- command
+To set a mapping, you should define it in `vim.keymaps`.
 
 An example, simple keybinding, can look like this:
 
 ```nix
 {
-  vim.maps.normal = {
-    "<leader>wq" = {
+  vim.keymaps = [
+    {
+      key = "<leader>wq";
+      mode = ["n"];
       action = ":wq<CR>";
       silent = true;
       desc = "Save file and quit";
-    };
-  };
+    }
+  ];
 }
 ```
 
 There are many settings available in the options. Please refer to the
-[documentation](https://notashelf.github.io/nvf/options.html#opt-vim.maps.command._name_.action)
+[documentation](https://notashelf.github.io/nvf/options.html#opt-vim.keymaps)
 to see a list of them.
 
 **nvf** provides a list of helper commands, so that you don't have to write the

lib/types/plugins.nix

@@ -97,7 +97,7 @@ in {
 
       default = {};
       type = submodule {
-        freeformType = attrsOf anything;
+        freeformType = anything;
         options = opts;
       };
     };

modules/extra/deprecations.nix

@@ -31,6 +31,9 @@ in {
       vim.autocomplete.type has been removed in favor of per-plugin modules.
       You can enable nvim-cmp with vim.autocomplete.nvim-cmp.enable instead.
     '')
+    (mkRemovedOptionModule ["vim" "snippets" "vsnip" "enable"] ''
+      vim.snippets.vsnip.enable has been removed in favor of the more modern luasnip.
+    '')
     (mkRenamedOptionModule ["vim" "lsp" "lspkind" "mode"] ["vim" "lsp" "lspkind" "setupOpts" "mode"])
   ];
 }

modules/neovim/mappings/options.nix

@@ -1,5 +1,5 @@
 {lib, ...}: let
-  inherit (lib.options) mkOption;
+  inherit (lib.options) mkOption literalMD;
   inherit (lib.types) either str listOf attrsOf nullOr submodule;
   inherit (lib.nvim.config) mkBool;
 
@@ -42,7 +42,7 @@
 
             See `:help map-modes` for a list of modes.
           '';
-          example = ''`["n" "v" "c"]` for normal, visual and command mode'';
+          example = literalMD ''`["n" "v" "c"]` for normal, visual and command mode'';
         };
       };
   };

modules/plugins/autopairs/nvim-autopairs/config.nix

@@ -12,7 +12,9 @@ in {
   config = mkIf cfg.enable {
     vim = {
       startPlugins = ["nvim-autopairs"];
-      pluginRC.autopairs = entryAnywhere "require('nvim-autopairs').setup(${toLuaObject cfg.setupOpts})";
+      pluginRC.autopairs = entryAnywhere ''
+        require('nvim-autopairs').setup(${toLuaObject cfg.setupOpts})
+      '';
     };
   };
 }

modules/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix

@@ -8,7 +8,7 @@ in {
   ];
 
   options.vim.autopairs.nvim-autopairs = {
-    enable = mkEnableOption "autopairs" // {default = false;};
+    enable = mkEnableOption "autopairs";
     setupOpts = mkPluginSetupOption "nvim-autopairs" {};
   };
 }

modules/plugins/completion/nvim-cmp/nvim-cmp.nix

@@ -14,7 +14,7 @@
   cfg = config.vim.autocomplete.nvim-cmp;
 in {
   options.vim.autocomplete.nvim-cmp = {
-    enable = mkEnableOption "nvim-cmp" // {default = false;};
+    enable = mkEnableOption "nvim-cmp";
     setupOpts = mkPluginSetupOption "the autocomplete plugin" {
       completion.completeopt = mkOption {
         type = str;

modules/plugins/debugger/nvim-dap/config.nix

@@ -16,57 +16,61 @@
 in {
   config = mkMerge [
     (mkIf cfg.enable {
-      vim.startPlugins = ["nvim-dap"];
+      vim = {
+        startPlugins = ["nvim-dap"];
 
-      vim.pluginRC =
-        {
-          # TODO customizable keymaps
-          nvim-dap = entryAnywhere ''
-            local dap = require("dap")
-            vim.fn.sign_define("DapBreakpoint", { text = "🛑", texthl = "ErrorMsg", linehl = "", numhl = "" })
-          '';
-        }
-        // mapAttrs (_: v: (entryAfter ["nvim-dap"] v)) cfg.sources;
+        pluginRC =
+          {
+            # TODO customizable keymaps
+            nvim-dap = entryAnywhere ''
+              local dap = require("dap")
+              vim.fn.sign_define("DapBreakpoint", { text = "🛑", texthl = "ErrorMsg", linehl = "", numhl = "" })
+            '';
+          }
+          // mapAttrs (_: v: (entryAfter ["nvim-dap"] v)) cfg.sources;
 
-      vim.maps.normal = mkMerge [
-        (mkSetLuaBinding mappings.continue "require('dap').continue")
-        (mkSetLuaBinding mappings.restart "require('dap').restart")
-        (mkSetLuaBinding mappings.terminate "require('dap').terminate")
-        (mkSetLuaBinding mappings.runLast "require('dap').run_last")
+        maps.normal = mkMerge [
+          (mkSetLuaBinding mappings.continue "require('dap').continue")
+          (mkSetLuaBinding mappings.restart "require('dap').restart")
+          (mkSetLuaBinding mappings.terminate "require('dap').terminate")
+          (mkSetLuaBinding mappings.runLast "require('dap').run_last")
 
-        (mkSetLuaBinding mappings.toggleRepl "require('dap').repl.toggle")
-        (mkSetLuaBinding mappings.hover "require('dap.ui.widgets').hover")
-        (mkSetLuaBinding mappings.toggleBreakpoint "require('dap').toggle_breakpoint")
+          (mkSetLuaBinding mappings.toggleRepl "require('dap').repl.toggle")
+          (mkSetLuaBinding mappings.hover "require('dap.ui.widgets').hover")
+          (mkSetLuaBinding mappings.toggleBreakpoint "require('dap').toggle_breakpoint")
 
-        (mkSetLuaBinding mappings.runToCursor "require('dap').run_to_cursor")
-        (mkSetLuaBinding mappings.stepInto "require('dap').step_into")
-        (mkSetLuaBinding mappings.stepOut "require('dap').step_out")
-        (mkSetLuaBinding mappings.stepOver "require('dap').step_over")
-        (mkSetLuaBinding mappings.stepBack "require('dap').step_back")
+          (mkSetLuaBinding mappings.runToCursor "require('dap').run_to_cursor")
+          (mkSetLuaBinding mappings.stepInto "require('dap').step_into")
+          (mkSetLuaBinding mappings.stepOut "require('dap').step_out")
+          (mkSetLuaBinding mappings.stepOver "require('dap').step_over")
+          (mkSetLuaBinding mappings.stepBack "require('dap').step_back")
 
-        (mkSetLuaBinding mappings.goUp "require('dap').up")
-        (mkSetLuaBinding mappings.goDown "require('dap').down")
-      ];
+          (mkSetLuaBinding mappings.goUp "require('dap').up")
+          (mkSetLuaBinding mappings.goDown "require('dap').down")
+        ];
+      };
     })
     (mkIf (cfg.enable && cfg.ui.enable) {
-      vim.startPlugins = ["nvim-dap-ui" "nvim-nio"];
+      vim = {
+        startPlugins = ["nvim-dap-ui" "nvim-nio"];
 
-      vim.pluginRC.nvim-dap-ui = entryAfter ["nvim-dap"] (''
-          local dapui = require("dapui")
-          dapui.setup()
-        ''
-        + optionalString cfg.ui.autoStart ''
-          dap.listeners.after.event_initialized["dapui_config"] = function()
-            dapui.open()
-          end
-          dap.listeners.before.event_terminated["dapui_config"] = function()
-            dapui.close()
-          end
-          dap.listeners.before.event_exited["dapui_config"] = function()
-            dapui.close()
-          end
-        '');
-      vim.maps.normal = mkSetLuaBinding mappings.toggleDapUI "require('dapui').toggle";
+        pluginRC.nvim-dap-ui = entryAfter ["nvim-dap"] (''
+            local dapui = require("dapui")
+            dapui.setup()
+          ''
+          + optionalString cfg.ui.autoStart ''
+            dap.listeners.after.event_initialized["dapui_config"] = function()
+              dapui.open()
+            end
+            dap.listeners.before.event_terminated["dapui_config"] = function()
+              dapui.close()
+            end
+            dap.listeners.before.event_exited["dapui_config"] = function()
+              dapui.close()
+            end
+          '');
+        maps.normal = mkSetLuaBinding mappings.toggleDapUI "require('dapui').toggle";
+      };
     })
   ];
 }

modules/plugins/snippets/luasnip/luasnip.nix

@@ -4,7 +4,7 @@
   inherit (lib.nvim.types) pluginType;
 in {
   options.vim.snippets.luasnip = {
-    enable = mkEnableOption "luasnip" // {default = false;};
+    enable = mkEnableOption "luasnip";
     providers = mkOption {
       type = listOf pluginType;
       default = ["friendly-snippets"];
@@ -12,7 +12,7 @@ in {
         The snippet provider packages.
 
         ::: {.note}
-        These are simply appended to `vim.startPlugins`.
+        These are simply appended to {option} `vim.startPlugins`.
         :::
       '';
       example = literalExpression "[\"vimPlugins.vim-snippets\"]";