1
0
mirror of https://github.com/nix-community/home-manager synced 2024-07-02 11:28:32 +02:00
home-manager/modules/programs/i3status.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

202 lines
5.1 KiB
Nix

{ 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 (lib.mdDoc "i3status");
enableDefault = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc ''
Whether or not to enable
the default configuration.
'';
};
general = mkOption {
type = settingsType;
default = { };
description = lib.mdDoc ''
Configuration to add to i3status {file}`config`
`general` section.
See
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
{
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 = lib.mdDoc ''
Whether or not to enable this module.
'';
};
position = mkOption {
type = with types; either int float;
description = lib.mdDoc ''
Position of this module in i3status `order`.
'';
};
settings = mkOption {
type = settingsType;
default = { };
description = lib.mdDoc ''
Configuration to add to this i3status module.
See
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
{
format = " %volume";
format_muted = " muted (%volume)";
device = "pulse:1";
}
'';
};
};
});
default = { };
description = lib.mdDoc ''
Modules to add to i3status {file}`config` file.
See
{manpage}`i3status(1)`
for options.
'';
example = literalExpression ''
{
"volume master" = {
position = 1;
settings = {
format = " %volume";
format_muted = " muted (%volume)";
device = "pulse:1";
};
};
"disk /" = {
position = 2;
settings = {
format = "/ %avail";
};
};
}
'';
};
package = mkPackageOptionMD pkgs "i3status" { };
};
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 = [ cfg.package ];
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));
};
}