From 2089eb407d8c5dbd6ca6e93d4988a439ca6446fd Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Sun, 28 Jul 2024 01:56:42 +0100
Subject: [PATCH] plugins/which-key: deprecate v2 registrations

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.
---
 plugins/utils/which-key.nix                   | 57 +++++++++++--
 .../test-sources/plugins/utils/which-key.nix  | 79 +++++++++++--------
 2 files changed, 96 insertions(+), 40 deletions(-)

diff --git a/plugins/utils/which-key.nix b/plugins/utils/which-key.nix
index 20ef2bb1..53ca6d0d 100644
--- a/plugins/utils/which-key.nix
+++ b/plugins/utils/which-key.nix
@@ -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})
         '');
     };
diff --git a/tests/test-sources/plugins/utils/which-key.nix b/tests/test-sources/plugins/utils/which-key.nix
index 26be2fa1..78c40f2c 100644
--- a/tests/test-sources/plugins/utils/which-key.nix
+++ b/tests/test-sources/plugins/utils/which-key.nix
@@ -8,46 +8,57 @@
       enable = true;
 
       # Testing for registrations
-      registrations."f" = {
-        prefix = "<leader>";
-        mode = [
-          "n"
-          "v"
-          "i"
-          "t"
-          "c"
-          "x"
-          "s"
-          "o"
-        ];
-        name = "Group Test";
-        f = "Label Test";
-        "1" = [
+      settings.spec =
+        let
+          mode = [
+            "n"
+            "v"
+            "i"
+            "t"
+            "c"
+            "x"
+            "s"
+            "o"
+          ];
+        in
+        [
           {
-            __raw = ''
+            __unkeyed-1 = "<leader>f";
+            group = "Group Test";
+            inherit mode;
+          }
+          {
+            __unkeyed-1 = "<leader>ff";
+            desc = "Label Test";
+            inherit mode;
+          }
+          {
+            __unkeyed-1 = "<leader>f1";
+            __unkeyed-2.__raw = ''
               function()
-                print("Raw Lua Code and List KeyMapping Test")
+                print("Raw Lua KeyMapping Test")
               end
             '';
+            desc = "Raw Lua KeyMapping Test";
+            inherit mode;
+          }
+          {
+            __unkeyed-1 = "<leader>foo";
+            desc = "Label Test 2";
+            inherit mode;
+          }
+          {
+            __unkeyed-1 = "<leader>f<tab>";
+            group = "Group in Group Test";
+            inherit mode;
+          }
+          {
+            __unkeyed-1 = "<leader>f<tab>f";
+            __unkeyed-2 = "<cmd>echo 'Vim cmd KeyMapping Test'<cr>";
+            desc = "Vim cmd KeyMapping Test";
+            inherit mode;
           }
-          "Raw Lua Code and List KeyMapping Test"
         ];
-        "oo" = "Label Test 2";
-        "<tab>" = {
-          name = "Group in Group Test";
-          f = [
-            {
-              __raw = ''
-                function()
-                  vim.cmd("echo 'Raw Lua Code and List KeyMapping Test 2'")
-                end
-              '';
-            }
-
-            "Raw Lua Code and List KeyMapping Test 2"
-          ];
-        };
-      };
 
       plugins = {
         marks = true;