mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-23 17:28:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

plugins/which-key: deprecate v2 registrations

Browse source 
These have been replaced in v3 with a new spec.

As we will soon migrate which-key to `settings` options, I've named the
new option `settings.spec` so that we do not need to "rename" it again
soon.

This commit **does not** actually add a freeform settings option.
This commit is contained in:
Matt Sturgeon 2024-07-28 01:56:42 +01:00
parent 2415edc0cb
commit 2089eb407d
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 96 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

57
plugins/utils/which-key.nix
View file

@ -3,6 +3,7 @@
helpers,
pkgs,
config,
options,
...
}:
with lib;
@ -14,11 +15,44 @@ with lib;
registrations = mkOption {
type = with types; attrsOf anything;
default = { };
description = "Manually register the description of mappings.";
example = {
"<leader>p" = "Find git files with telescope";
};
description = ''
This option is deprecated, use `settings.spec` instead.
Note: the keymap format has changed in v3 of which-key.
'';
visible = false;
};
settings.spec = helpers.defaultNullOpts.mkListOf' {
type = with types; attrsOf anything;
pluginDefault = [ ];
description = ''
WhichKey automatically gets the descriptions of your keymaps from the desc attribute of the keymap.
So for most use-cases, you don't need to do anything else.
However, the mapping spec is still useful to configure group descriptions and mappings that don't really exist as a regular keymap.
Please refer to the plugin's [documentation](https://github.com/folke/which-key.nvim?tab=readme-ov-file#%EF%B8%8F-mappings).
'';
example = [
{
__unkeyed-1 = "<leader>w";
desc = "Window actions";
}
{
__unkeyed-1 = "<leader>b";
desc = "Buffer actions";
}
{
__unkeyed-1 = "<leader>p";
desc = "Find git files with telescope";
}
{
__unkeyed-1 = "<leader>p";
__unkeyed-2.__raw = "function() print('Optional action') end";
desc = "Print \"optional action\"";
}
];
};
plugins = {
@ -203,6 +237,7 @@ with lib;
config =
let
cfg = config.plugins.which-key;
opt = options.plugins.which-key;
setupOptions = {
plugins = {
inherit (cfg.plugins) marks registers spelling;
@ -246,6 +281,7 @@ with lib;
inherit (cfg) hidden;
show_help = cfg.showHelp;
show_keys = cfg.showKeys;
inherit (cfg.settings) spec;
inherit (cfg) triggers;
triggers_nowait = cfg.triggersNoWait;
triggers_blacklist = cfg.triggersBlackList;
@ -255,11 +291,20 @@ with lib;
mkIf cfg.enable {
extraPlugins = [ cfg.package ];
warnings = optional opt.registrations.isDefined ''
nixvim (plugins.which-key):
The option definition `plugins.which-key.registrations' in ${showFiles opt.registrations.files} has been deprecated in which-key v3; please remove it.
You should use `plugins.which-key.settings.spec' instead.
Note: the spec format has changed in which-key v3
See: https://github.com/folke/which-key.nvim?tab=readme-ov-file#%EF%B8%8F-mappings
'';
extraConfigLua =
''
require("which-key").setup(${helpers.toLuaObject setupOptions})
''
+ (optionalString (cfg.registrations != { }) ''
+ (optionalString (opt.registrations.isDefined && cfg.registrations != { }) ''
require("which-key").register(${helpers.toLuaObject cfg.registrations})
'');
};