nix/12.nixvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

plugins/mkdnflow: properly handle old mappings

Browse source 
Migrate user's with old mappings to new format and warn about change.
This commit is contained in:
Austin Horstman 2026-02-11 15:30:14 -06:00
parent 6acc964664
commit e49b8deda7
2 changed files with 174 additions and 118 deletions
Download patch file Download diff file Expand all files Collapse all files

36
plugins/by-name/mkdnflow/default.nix
View file

@ -8,6 +8,42 @@ lib.nixvim.plugins.mkNeovimPlugin {
maintainers = [ lib.maintainers.khaneliman ];
settingsOptions = {
mappings = lib.nixvim.mkNullOrOption' {
type = with lib.types; attrsOf anything;
description = ''
Key mappings for mkdnflow commands.
Use the generated positional format for mapping entries:
- `false` to disable a command mapping.
- `[modes key]`, where `modes` is a string or list of mode strings.
'';
apply = lib.mapNullable (
mappings:
let
isLegacyMapping = mapping: lib.isAttrs mapping && mapping ? modes && mapping ? key;
legacyMappings = lib.filterAttrs (_: isLegacyMapping) mappings;
normalizedMappings =
mappings
// lib.mapAttrs (_: mapping: [
mapping.modes
mapping.key
]) legacyMappings;
in
# TODO: Added 2026-02-11, remove after 27.05
lib.warnIf (legacyMappings != { }) ''
Nixvim (plugins.mkdnflow): Setting `plugins.mkdnflow.settings.mappings.<name> = { modes = ...; key = ...; }` is deprecated.
Use `plugins.mkdnflow.settings.mappings.<name> = [ <modes> <key> ];` instead.
Example:
`MkdnEnter = [ [ "n" "i" ] "<CR>" ];`
Legacy mappings in this definition: ${lib.concatStringsSep ", " (lib.attrNames legacyMappings)}
'' normalizedMappings
);
};
};
settingsExample = {
modules = {
bib = false;

256
tests/test-sources/plugins/by-name/mkdnflow/default.nix
View file

@ -77,134 +77,154 @@
override = false;
};
};
mappings = {
MkdnEnter = [
[
"n"
"v"
"i"
]
"<CR>"
];
MkdnTab = false;
MkdnSTab = false;
MkdnNextLink = [
"n"
"<Tab>"
];
MkdnPrevLink = [
"n"
"<S-Tab>"
];
MkdnNextHeading = [
"n"
"]]"
];
MkdnPrevHeading = [
"n"
"[["
];
MkdnGoBack = [
"n"
"<BS>"
];
MkdnGoForward = [
"n"
"<Del>"
];
MkdnFollowLink = false;
MkdnCreateLink = false;
MkdnCreateLinkFromClipboard = [
[
"n"
"v"
]
"<leader>p"
];
MkdnDestroyLink = [
"n"
"<M-CR>"
];
MkdnMoveSource = [
"n"
"<F2>"
];
MkdnYankAnchorLink = [
"n"
"ya"
];
MkdnYankFileAnchorLink = [
"n"
"yfa"
];
MkdnIncreaseHeading = [
"n"
"+"
];
MkdnDecreaseHeading = [
"n"
"-"
];
MkdnToggleToDo = [
[
"n"
"v"
]
"<C-Space>"
];
MkdnNewListItem = false;
MkdnNewListItemBelowInsert = [
"n"
"o"
];
MkdnNewListItemAboveInsert = [
"n"
"O"
];
MkdnExtendList = false;
MkdnUpdateNumbering = [
"n"
"<leader>nn"
];
MkdnTableNextCell = [
"i"
"<Tab>"
];
MkdnTablePrevCell = [
"i"
"<S-Tab>"
];
MkdnTableNextRow = false;
MkdnTablePrevRow = [
"i"
"<M-CR>"
];
MkdnTableNewRowBelow = [
"n"
"<leader>ir"
];
MkdnTableNewRowAbove = [
"n"
"<leader>iR"
];
MkdnTableNewColAfter = [
"n"
"<leader>ic"
];
MkdnTableNewColBefore = [
"n"
"<leader>iC"
];
MkdnFoldSection = [
"n"
"<leader>f"
];
MkdnUnfoldSection = [
"n"
"<leader>F"
];
};
};
};
};
mappings-deprecated = {
plugins.mkdnflow = {
enable = true;
settings = {
mappings = {
MkdnEnter = {
modes = [
"n"
"v"
"i"
];
key = "<CR>";
};
MkdnTab = false;
MkdnSTab = false;
MkdnNextLink = {
modes = "n";
key = "<Tab>";
};
MkdnPrevLink = {
modes = "n";
key = "<S-Tab>";
};
MkdnNextHeading = {
modes = "n";
key = "]]";
};
MkdnPrevHeading = {
modes = "n";
key = "[[";
};
MkdnGoBack = {
modes = "n";
key = "<BS>";
};
MkdnGoForward = {
modes = "n";
key = "<Del>";
};
MkdnFollowLink = false;
MkdnCreateLink = false;
MkdnCreateLinkFromClipboard = {
modes = [
"n"
"v"
];
key = "<leader>p";
};
MkdnDestroyLink = {
modes = "n";
key = "<M-CR>";
};
MkdnMoveSource = {
modes = "n";
key = "<F2>";
};
MkdnYankAnchorLink = {
modes = "n";
key = "ya";
};
MkdnYankFileAnchorLink = {
modes = "n";
key = "yfa";
};
MkdnIncreaseHeading = {
modes = "n";
key = "+";
};
MkdnDecreaseHeading = {
modes = "n";
key = "-";
};
MkdnToggleToDo = {
modes = [
"n"
"v"
];
key = "<C-Space>";
};
MkdnNewListItem = false;
MkdnNewListItemBelowInsert = {
modes = "n";
key = "o";
};
MkdnNewListItemAboveInsert = {
modes = "n";
key = "O";
};
MkdnExtendList = false;
MkdnUpdateNumbering = {
modes = "n";
key = "<leader>nn";
};
MkdnTableNextCell = {
modes = "i";
key = "<Tab>";
};
MkdnTablePrevCell = {
modes = "i";
key = "<S-Tab>";
};
MkdnTableNextRow = false;
MkdnTablePrevRow = {
modes = "i";
key = "<M-CR>";
};
MkdnTableNewRowBelow = {
modes = "n";
key = "<leader>ir";
};
MkdnTableNewRowAbove = {
modes = "n";
key = "<leader>iR";
};
MkdnTableNewColAfter = {
modes = "n";
key = "<leader>ic";
};
MkdnTableNewColBefore = {
modes = "n";
key = "<leader>iC";
};
MkdnFoldSection = {
modes = "n";
key = "<leader>f";
};
MkdnUnfoldSection = {
modes = "n";
key = "<leader>F";
};
};
};
};
test.runNvim = false;
};
}