pgcli: init (#7072)

modules/lib/maintainers.nix

@@ -333,6 +333,12 @@
     github = "msyds";
     githubId = 65362461;
   };
+  nickthegroot = {
+    name = "Nick DeGroot";
+    email = "nick@nickthegroot.com";
+    github = "nickthegroot";
+    githubId = 1966472;
+  };
   nikp123 = {
     name = "nikp123";
     email = "nikp123@users.noreply.github.com";

modules/misc/news/2025/05/2025-05-15_14-37-58.nix

@@ -0,0 +1,9 @@
+{
+  time = "2025-05-15T21:37:58+00:00";
+  condition = true;
+  message = ''
+    A new module is available: `programs.pgcli`
+
+    pgcli is a Python CLI that lets you connect to Postgres databases and run queries with syntax highlighting and auto-completion.
+  '';
+}

modules/modules.nix

@@ -226,6 +226,7 @@ let
       ./programs/pay-respects.nix
       ./programs/pazi.nix
       ./programs/pet.nix
+      ./programs/pgcli.nix
       ./programs/pidgin.nix
       ./programs/pistol.nix
       ./programs/piston-cli.nix

modules/programs/pgcli.nix

@@ -0,0 +1,58 @@
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+
+let
+
+  inherit (lib)
+    mkEnableOption
+    mkPackageOption
+    mkOption
+    literalExpression
+    ;
+
+  iniFormat = pkgs.formats.ini { };
+  cfg = config.programs.pgcli;
+
+in
+{
+  meta.maintainers = [ lib.hm.maintainers.nickthegroot ];
+
+  options.programs.pgcli = {
+    enable = mkEnableOption "pgcli";
+
+    package = mkPackageOption pkgs "pgcli" { nullable = true; };
+
+    settings = mkOption {
+      type = iniFormat.type;
+      default = { };
+      example = literalExpression ''
+        {
+          main = {
+            smart_completion = true;
+            vi = true;
+          };
+
+          "named queries".simple = "select * from abc where a is not Null";
+        }
+      '';
+      description = ''
+        Configuration written to
+        {file}`$XDG_CONFIG_HOME/pgcli/config`.
+        See <https://www.pgcli.com/config>
+        for more information.
+      '';
+    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    home.packages = lib.mkIf (cfg.package != null) [ cfg.package ];
+
+    xdg.configFile."pgcli/config" = lib.mkIf (cfg.settings != { }) {
+      source = iniFormat.generate "pgcli-config" cfg.settings;
+    };
+  };
+}

tests/default.nix

@@ -266,6 +266,7 @@ import nmtSrc {
       ./modules/programs/papis
       ./modules/programs/pay-respects
       ./modules/programs/pet
+      ./modules/programs/pgcli
       ./modules/programs/pistol
       ./modules/programs/pls
       ./modules/programs/poetry

tests/modules/programs/pgcli/default.nix

@@ -0,0 +1,4 @@
+{
+  pgcli-example-settings = ./example-settings.nix;
+  pgcli-empty-settings = ./empty-settings.nix;
+}

tests/modules/programs/pgcli/empty-settings.nix

@@ -0,0 +1,7 @@
+{
+  programs.pgcli.enable = true;
+
+  nmt.script = ''
+    assertPathNotExists home-files/.config/pgcli/config
+  '';
+}

tests/modules/programs/pgcli/example-settings.nix

@@ -0,0 +1,23 @@
+{ config, ... }:
+
+let
+  expected = builtins.toFile "config" ''
+    [main]
+    vi=true
+  '';
+in
+{
+  programs.pgcli = {
+    enable = true;
+    package = config.lib.test.mkStubPackage { };
+
+    settings = {
+      main.vi = true;
+    };
+  };
+
+  nmt.script = ''
+    assertFileExists home-files/.config/pgcli/config
+    assertFileContent home-files/.config/pgcli/config '${expected}'
+  '';
+}