modules/autocmd: better handling of 'desc' option rename

nix-community · Oct 1, 2023 · 85abc48 · 85abc48
1 parent 3fa81dd
commit 85abc48
Showing 1 changed file with 21 additions and 7 deletions.
diff --git a/modules/autocmd.nix b/modules/autocmd.nix
@@ -17,13 +17,6 @@ with lib; let
   };
 
   autoCmdOption = types.submodule {
-    imports = [
-      (
-        # TODO remove this deprecation warning in December 2023
-        mkRenamedOptionModule
-        ["description"] ["desc"]
-      )
-    ];
     options = {
       event = helpers.mkNullOrOption (types.either types.str (types.listOf types.str)) ''
         The event or events to register this autocommand.
@@ -42,6 +35,12 @@ with lib; let
         Cannot be used with `pattern`.
       '';
 
+      # Introduced early October 2023.
+      # TODO remove in early December 2023.
+      description = helpers.mkNullOrOption types.str ''
+        DEPRECATED, please use `desc`.
+      '';
+
       desc = helpers.mkNullOrOption types.str ''
         A textual description of this autocommand.
       '';
@@ -114,6 +113,21 @@ in {
     inherit (config) autoGroups autoCmd;
   in
     mkIf (autoGroups != {} || autoCmd != {}) {
+      # Introduced early October 2023.
+      # TODO remove in early December 2023.
+      assertions = [
+        {
+          assertion =
+            all
+            (x: x.description == null)
+            autoCmd;
+          message = ''
+            RENAMED OPTION: `autoCmd[].description` has been renamed `autoCmd[].desc`.
+            Please update your configuration.
+          '';
+        }
+      ];
+
       extraConfigLuaPost =
         (optionalString (autoGroups != {}) ''
           -- Set up autogroups {{