mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

modules/keymaps: deprecate lua option

Browse source
This commit is contained in:
Matt Sturgeon 2024-05-26 10:46:36 +01:00
parent beb86eec7c
commit 8212bf1cd2
2 changed files with 37 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/keymap-helpers.nix
View file

@ -106,8 +106,12 @@ rec {
description = ''
If true, `action` is considered to be lua code.
Thus, it will not be wrapped in `""`.
This option is deprecated and will be removed in 24.11.
You should use a "raw" action instead, e.g. `action.__raw = ""`.
'';
default = defaults.lua or false;
visible = false;
};
options = mapConfigOptions;

37
modules/keymaps.nix
View file

@ -2,6 +2,7 @@
lib,
helpers,
config,
options,
...
}:
with lib;
@ -26,13 +27,11 @@ with lib;
"InsertEnter" = [
{
key = "<C-y>";
action = ''require("cmp").mapping.confirm()'';
lua = true;
action.__raw = ''require("cmp").mapping.confirm()'';
}
{
key = "<C-n>";
action = ''require("cmp").mapping.select_next_item()'';
lua = true;
action.__raw = ''require("cmp").mapping.select_next_item()'';
}
];
};
@ -52,6 +51,36 @@ with lib;
};
in
{
# Deprecate `lua` keymap option
# TODO upgrade to an assertion (removal notice) in 24.11
# TODO remove entirely in 25.05?
warnings =
let
luaDefs = pipe options.keymaps.definitionsWithLocations [
(map (def: {
inherit (def) file;
value = filter (hasAttr "lua") def.value;
}))
(filter (def: def.value != [ ]))
(map (
def:
let
count = length def.value;
plural = count > 1;
in
"Found ${toString count} use${optionalString plural "s"} in ${def.file}"
))
];
in
optional (luaDefs != [ ]) ''
Nixvim (keymaps): the `lua` keymap option is deprecated.
This option will be removed in 24.11. You should use a "raw" `action` instead;
e.g. `action.__raw = "<lua code>"` or `action = helpers.mkRaw "<lua code>"`.
${concatStringsSep "\n" luaDefs}
'';
extraConfigLua = optionalString (config.keymaps != [ ]) ''
-- Set up keybinds {{{
do