i3status: add module

PR #1210

modules/programs/i3status.nix

@@ -0,0 +1,208 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+  cfg = config.programs.i3status;
+
+  enabledModules = filterAttrs (n: v: v.enable) cfg.modules;
+
+  formatOrder = n: ''order += "${n}"'';
+
+  formatModule = n: v:
+    let
+      formatLine = n: v:
+        let
+          formatValue = v:
+            if isBool v then
+              (if v then "true" else "false")
+            else if isString v then
+              ''"${v}"''
+            else
+              toString v;
+        in "${n} = ${formatValue v}";
+    in ''
+      ${n} {
+        ${concatStringsSep "\n  " (mapAttrsToList formatLine v)}
+      }
+    '';
+
+  settingsType = with types; attrsOf (oneOf [ bool int str ]);
+
+  sortAttrNamesByPosition = comparator: set:
+    let pos = n: set."${n}".position;
+    in sort (a: b: comparator (pos a) (pos b)) (attrNames set);
+in {
+  meta.maintainers = [ hm.maintainers.justinlovinger ];
+
+  options.programs.i3status = {
+    enable = mkEnableOption "i3status";
+
+    enableDefault = mkOption {
+      type = types.bool;
+      default = true;
+      description = ''
+        Whether or not to enable
+        the default configuration.
+      '';
+    };
+
+    general = mkOption {
+      type = settingsType;
+      default = { };
+      description = ''
+        Configuration to add to i3status <filename>config</filename>
+        <code>general</code> section.
+        See
+        <citerefentry>
+         <refentrytitle>i3status</refentrytitle>
+         <manvolnum>1</manvolnum>
+        </citerefentry>
+        for options.
+      '';
+      example = literalExample ''
+        {
+          colors = true;
+          color_good = "#e0e0e0";
+          color_degraded = "#d7ae00";
+          color_bad = "#f69d6a";
+          interval = 1;
+        }
+      '';
+    };
+
+    modules = mkOption {
+      type = types.attrsOf (types.submodule {
+        options = {
+          enable = mkOption {
+            type = types.bool;
+            default = true;
+            description = ''
+              Whether or not to enable this module.
+            '';
+          };
+          position = mkOption {
+            type = with types; either int float;
+            description = ''
+              Position of this module in i3status <code>order</code>.
+            '';
+          };
+          settings = mkOption {
+            type = settingsType;
+            default = { };
+            description = ''
+              Configuration to add to this i3status module.
+              See
+              <citerefentry>
+               <refentrytitle>i3status</refentrytitle>
+               <manvolnum>1</manvolnum>
+              </citerefentry>
+              for options.
+            '';
+            example = literalExample ''
+              {
+                format = "♪ %volume";
+                format_muted = "♪ muted (%volume)";
+                device = "pulse:1";
+              }
+            '';
+          };
+        };
+      });
+      default = { };
+      description = ''
+        Modules to add to i3status <filename>config</filename> file.
+        See
+        <citerefentry>
+         <refentrytitle>i3status</refentrytitle>
+         <manvolnum>1</manvolnum>
+        </citerefentry>
+        for options.
+      '';
+      example = literalExample ''
+        {
+          "volume master" = {
+            position = 1;
+            settings = {
+              format = "♪ %volume";
+              format_muted = "♪ muted (%volume)";
+              device = "pulse:1";
+            };
+          };
+          "disk /" = {
+            position = 2;
+            settings = {
+              format = "/ %avail";
+            };
+          };
+        }
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    programs.i3status = mkIf cfg.enableDefault {
+      general = {
+        colors = mkDefault true;
+        interval = mkDefault 5;
+      };
+
+      modules = {
+        ipv6 = { position = mkDefault 1; };
+
+        "wireless _first_" = {
+          position = mkDefault 2;
+          settings = {
+            format_up = mkDefault "W: (%quality at %essid) %ip";
+            format_down = mkDefault "W: down";
+          };
+        };
+
+        "ethernet _first_" = {
+          position = mkDefault 3;
+          settings = {
+            format_up = mkDefault "E: %ip (%speed)";
+            format_down = mkDefault "E: down";
+          };
+        };
+
+        "battery all" = {
+          position = mkDefault 4;
+          settings = { format = mkDefault "%status %percentage %remaining"; };
+        };
+
+        "disk /" = {
+          position = mkDefault 5;
+          settings = { format = mkDefault "%avail"; };
+        };
+
+        load = {
+          position = mkDefault 6;
+          settings = { format = mkDefault "%1min"; };
+        };
+
+        memory = {
+          position = mkDefault 7;
+          settings = {
+            format = mkDefault "%used | %available";
+            threshold_degraded = mkDefault "1G";
+            format_degraded = mkDefault "MEMORY < %available";
+          };
+        };
+
+        "tztime local" = {
+          position = mkDefault 8;
+          settings = { format = mkDefault "%Y-%m-%d %H:%M:%S"; };
+        };
+      };
+    };
+
+    home.packages = [ pkgs.i3status ];
+
+    xdg.configFile."i3status/config".text = concatStringsSep "\n" ([ ]
+      ++ optional (cfg.general != { }) (formatModule "general" cfg.general)
+      ++ map formatOrder (sortAttrNamesByPosition lessThan enabledModules)
+      ++ mapAttrsToList formatModule
+      (mapAttrs (n: v: v.settings) enabledModules));
+  };
+}