cmus: add module

PR #5951

modules/lib/maintainers.nix

@@ -604,6 +604,12 @@
     github = "zorrobert";
     githubId = 118135271;
   };
+  joygnu = {
+    name = "joygnu";
+    email = "contact@joygnu.org";
+    github = "joygnu";
+    githubId = 152063003;
+  };
   callumio = {
     name = "Callum Leslie";
     email = "git+nix@cleslie.uk";

modules/misc/news.nix

@@ -1780,6 +1780,15 @@ in {
           See https://zed.dev for more.
         '';
       }
+
+      {
+        time = "2024-10-18T14:01:07+00:00";
+        message = ''
+          A new module is available: 'programs.cmus'.
+
+          cmus is a small, fast and powerful console music player.
+        '';
+      }
     ];
   };
 }

modules/modules.nix

@@ -77,6 +77,7 @@ let
     ./programs/carapace.nix
     ./programs/cava.nix
     ./programs/chromium.nix
+    ./programs/cmus.nix
     ./programs/command-not-found/command-not-found.nix
     ./programs/comodoro.nix
     ./programs/darcs.nix

modules/programs/cmus.nix

@@ -0,0 +1,44 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.cmus;
+
+in {
+  meta.maintainers = [ hm.maintainers.joygnu ];
+
+  options.programs.cmus = {
+    enable = mkEnableOption "Enable cmus, the music player.";
+
+    theme = mkOption {
+      type = types.lines;
+      default = "";
+      example = "gruvbox";
+      description = ''
+        Select color theme. A list of available color themes can be found
+        here: <https://github.com/cmus/cmus/tree/master/data>.
+      '';
+    };
+
+    extraConfig = mkOption {
+      type = types.lines;
+      default = "";
+      example = ''
+        set audio_backend = "mpd"
+        set status_display = "default"
+      '';
+      description = "Extra configuration to add to cmus {file}`rc`.";
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ pkgs.cmus ];
+
+    home.file.".config/cmus/rc".text = ''
+      ${optionalString (cfg.theme != "") "colorscheme ${cfg.theme}"}
+      ${cfg.extraConfig}
+    '';
+  };
+}

tests/default.nix

@@ -67,6 +67,7 @@ in import nmtSrc {
     ./modules/programs/btop
     ./modules/programs/carapace
     ./modules/programs/cava
+    ./modules/programs/cmus
     ./modules/programs/comodoro
     ./modules/programs/darcs
     ./modules/programs/dircolors

tests/modules/programs/cmus/cmus.nix

@@ -0,0 +1,20 @@
+{ ... }:
+
+{
+  programs.cmus = {
+    enable = true;
+    theme = "gruvbox";
+    extraConfig = "test";
+  };
+
+  nmt.script = ''
+    assertFileContent \
+      home-files/.config/cmus/rc \
+      ${
+        builtins.toFile "cmus-expected-rc" ''
+          colorscheme gruvbox
+          test
+        ''
+      }
+  '';
+}

tests/modules/programs/cmus/default.nix

@@ -0,0 +1 @@
+{ cmus = ./cmus.nix; }