Merge pull request #1450 from alfarelcynthesis/no-default-mappings-option

treewide: allow disabling nvf mappings
This commit is contained in:
Alfarel 2026-04-10 13:04:12 -04:00 committed by GitHub
commit 3ab2d5d876
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
52 changed files with 489 additions and 622 deletions

View file

@ -1,7 +1,9 @@
# Custom keymaps {#ch-keymaps}
Some plugin modules provide keymap options for your convenience. If a keymap is
not provided by such module options, you may easily register your own custom
Some plugin modules provide keymap options for your convenience. These can be
disabled by toggling {option}`vim.vendoredKeymaps.enable`. It is also possible
to disable individual keymaps with options by setting them to `null`. If a
keymap is not provided by a module, you may easily register your own custom
keymaps via {option}`vim.keymaps`.
```nix
@ -22,7 +24,7 @@ keymaps via {option}`vim.keymaps`.
{
key = "<leader>k";
mode = ["n" "x"];
# While `lua` is `true`, `action` is expected to be
# a valid Lua expression.
lua = true;

View file

@ -768,7 +768,7 @@ usage should look something like this:
# pluginDefinition.nix
{lib, ...}: let
inherit (lib.options) mkEnableOption;
inherit (lib.nvim.binds) mkMappingOption;
inherit (config.vim.lib) mkMappingOption;
in {
options.vim.plugin = {
enable = mkEnableOption "Enable plugin";

View file

@ -195,6 +195,7 @@
{command}`:healthcheck` doesn't know that.
- Remove [which-key.nvim] `<leader>o` `+Notes` description which did not
actually correspond to any keybinds.
- Allow disabling nvf's vendored keymaps by toggling `vendoredKeymaps.enable`.
[pyrox0](https://github.com/pyrox0):