plugins/surround: rename to vim-surround

Adding nvim-surround so we need to deprecate the generic name and move
it.

Author: khaneliman

plugins/by-name/surround/default.nix renamed to plugins/by-name/vim-surround/default.nix

@@ -4,7 +4,7 @@
   ...
 }:
 helpers.vim-plugin.mkVimPlugin {
-  name = "surround";
+  name = "vim-surround";
   originalName = "surround.vim";
   package = "vim-surround";
 

plugins/deprecation.nix

@@ -10,13 +10,31 @@ let
       - `:PreviewQuery` to open the Query Editor (Nvim 0.10+)
     '';
   };
+  renamed = {
+    # Added 2024-09-17
+    surround = "vim-surround";
+  };
 in
 {
-  imports = lib.mapAttrsToList (
-    name:
-    lib.mkRemovedOptionModule [
-      "plugins"
-      name
-    ]
-  ) removed;
+
+  imports =
+    (lib.mapAttrsToList (
+      name:
+      lib.mkRemovedOptionModule [
+        "plugins"
+        name
+      ]
+    ) removed)
+    ++ (lib.mapAttrsToList (
+      old: new:
+      lib.mkRenamedOptionModule
+        [
+          "plugins"
+          old
+        ]
+        [
+          "plugins"
+          new
+        ]
+    ) renamed);
 }

tests/test-sources/plugins/by-name/surround/default.nix

@@ -0,0 +1,5 @@
+{
+  empty = {
+    plugins.vim-surround.enable = true;
+  };
+}