taskwarrior: support taskwarrior3 migration

Support taskwarrior3 migration, following the approach in [1] to avoid breaking changes. [1]: NixOS/nixpkgs#303632 Closes: nix-community#5310 Link: nix-community#5782
Nealium · Sep 7, 2024 · aaebdea · aaebdea
1 parent 127ccc3
commit aaebdea
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/modules/programs/taskwarrior.nix b/modules/programs/taskwarrior.nix
@@ -85,7 +85,8 @@ in {
         '';
       };
 
-      package = mkPackageOption pkgs "taskwarrior" { };
+      package =
+        mkPackageOption pkgs "taskwarrior" { example = "pkgs.taskwarrior3"; };
     };
   };
 

diff --git a/modules/services/taskwarrior-sync.nix b/modules/services/taskwarrior-sync.nix
@@ -12,7 +12,8 @@ in {
   options.services.taskwarrior-sync = {
     enable = mkEnableOption "Taskwarrior periodic sync";
 
-    package = mkPackageOption pkgs "taskwarrior" { };
+    package =
+      mkPackageOption pkgs "taskwarrior" { example = "pkgs.taskwarrior3"; };
 
     frequency = mkOption {
       type = types.str;

diff --git a/tests/modules/programs/taskwarrior/taskwarrior.nix b/tests/modules/programs/taskwarrior/taskwarrior.nix
@@ -6,6 +6,7 @@ with lib;
   config = {
     programs.taskwarrior = {
       enable = true;
+      package = pkgs.taskwarrior3;
       colorTheme = "dark-violets-256";
       dataLocation = "/some/data/location";
       config = {
@@ -18,7 +19,7 @@ with lib;
       '';
     };
 
-    test.stubs.taskwarrior = { };
+    test.stubs.taskwarrior3 = { };
 
     nmt.script = ''
       assertFileExists home-files/.config/task/home-manager-taskrc
-Original file line number
+Diff line change
@@ Expand Up / @@ -85,7 +85,8 @@ in { @@
             '';
           };
-          package = mkPackageOption pkgs "taskwarrior" { };
+          package =
+            mkPackageOption pkgs "taskwarrior" { example = "pkgs.taskwarrior3"; };
         };
       };
@@ Expand Down @@