From 29e9725bb7cb120edb10a39c282f1cdace23aaaa Mon Sep 17 00:00:00 2001
From: Fernando Rodrigues <alpha@sigmasquadron.net>
Date: Thu, 21 Nov 2024 20:26:50 +0000
Subject: [PATCH] nixos/pay-respects: add runtimeRules option

Signed-off-by: Fernando Rodrigues <alpha@sigmasquadron.net>
---
 nixos/modules/programs/pay-respects.nix | 48 +++++++++++++++++++++++--
 1 file changed, 46 insertions(+), 2 deletions(-)

diff --git a/nixos/modules/programs/pay-respects.nix b/nixos/modules/programs/pay-respects.nix
index 83822cdc2c7f..96f56a7ce576 100644
--- a/nixos/modules/programs/pay-respects.nix
+++ b/nixos/modules/programs/pay-respects.nix
@@ -7,16 +7,22 @@
 let
   inherit (lib)
     getExe
+    literalExpression
     maintainers
     mkEnableOption
     mkIf
+    mkMerge
     mkOption
     optionalString
     types
     ;
-  inherit (types) str;
+  inherit (types) listOf str;
+
   cfg = config.programs.pay-respects;
 
+  settingsFormat = pkgs.formats.toml { };
+  inherit (settingsFormat) generate type;
+
   initScript =
     shell:
     if (shell != "fish") then
@@ -41,11 +47,49 @@ in
           The default value is `f`, but you can use anything else as well.
         '';
       };
+      runtimeRules = mkOption {
+        type = listOf type;
+        default = [ ];
+        example = literalExpression ''
+          [
+            {
+              command = "xl";
+              match_err = [
+                {
+                  pattern = [
+                    "Permission denied"
+                  ];
+                  suggest = [
+                    '''
+                      #[executable(sudo), !cmd_contains(sudo), err_contains(libxl: error:)]
+                      sudo {{command}}
+                    '''
+                  ];
+                }
+              ];
+            }
+          ];
+        '';
+        description = ''
+          List of rules to be added to `/etc/xdg/pay-respects/rules`.
+          `pay-respects` will read the contents of these generated rules to recommend command corrections.
+          Each rule module should start with the `command` attribute that specifies the command name. See the [upstream documentation](https://codeberg.org/iff/pay-respects/src/branch/main/rules.md) for more information.
+        '';
+      };
     };
   };
 
   config = mkIf cfg.enable {
-    environment.systemPackages = [ pkgs.pay-respects ];
+    environment = mkMerge (
+      [
+        {
+          systemPackages = [ pkgs.pay-respects ];
+        }
+      ]
+      ++ map (rule: {
+        etc."xdg/pay-respects/rules/${rule.command}.toml".source = generate "${rule.command}.toml" rule;
+      }) cfg.runtimeRules
+    );
 
     programs = {
       bash.interactiveShellInit = initScript "bash";