From caef79e398faf1c38b29d657c206f13393d24938 Mon Sep 17 00:00:00 2001
From: Ching Pei Yang <badnam3o.0@gmail.com>
Date: Fri, 12 Jun 2026 14:01:12 +0200
Subject: [PATCH] mappings: deprecate vim.maps

---
 modules/neovim/init/mappings.nix | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/modules/neovim/init/mappings.nix b/modules/neovim/init/mappings.nix
index 0f665101..5890f372 100644
--- a/modules/neovim/init/mappings.nix
+++ b/modules/neovim/init/mappings.nix
@@ -1,13 +1,14 @@
 {
+  options,
   config,
   lib,
   ...
 }: let
   inherit (lib.modules) mkMerge;
-  inherit (lib.options) mkOption literalMD;
+  inherit (lib.options) mkOption literalMD showFiles;
   inherit (lib.types) either str listOf attrsOf nullOr submodule;
   inherit (lib.attrsets) mapAttrsToList;
-  inherit (lib.lists) flatten;
+  inherit (lib.lists) flatten optional;
   inherit (lib.trivial) pipe;
   inherit (lib.options) mkEnableOption;
   inherit (lib.nvim.config) mkBool;
@@ -63,10 +64,10 @@
   legacyMapOption = mode:
     mkOption {
       description = "Mappings for ${mode} mode";
+      visible = false;
       type = attrsOf (submodule {
         options = mapConfigOptions;
       });
-      default = {};
     };
 
   legacyMapModes = {
@@ -152,5 +153,14 @@ in {
         ]
       )
     ];
+
+    # 2026-06-12
+    warnings = mkMerge (mapAttrsToList (
+        name: option:
+          optional
+          option.isDefined
+          "The option `vim.maps.${name}` defined in ${showFiles option.files} is deprecated, please use `vim.keymaps` instead. "
+      )
+      options.vim.maps);
   };
 }