home-manager/modules/services/window-managers/spectrwm.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

135 lines
3.5 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.xsession.windowManager.spectrwm;
renderedValue = val:
if isBool val then if val then "1" else "0" else toString val;
renderedSettings = settings:
mapAttrsToList (name: value: "${name} = ${renderedValue value}") settings;
renderedBindings = bindings:
mapAttrsToList (name: value: "bind[${name}] = ${value}") bindings;
renderedUnbindings = unbindings: map (value: "bind[] = ${value}") unbindings;
renderedPrograms = programs:
mapAttrsToList (name: value: "program[${name}] = ${value}") programs;
renderedQuirks = quirks:
mapAttrsToList (name: value: "quirk[${name}] = ${value}") quirks;
settingType = types.oneOf [ types.bool types.int types.str ];
in {
meta.maintainers = [ hm.maintainers.loicreynier ];
options = {
xsession.windowManager.spectrwm = {
enable = mkEnableOption (lib.mdDoc "Spectrwm window manager");
package = mkOption {
type = types.package;
default = pkgs.spectrwm;
defaultText = literalExpression "pkgs.spectrwm";
description = lib.mdDoc ''
Package providing the {command}`spectrwm` command.
'';
};
settings = mkOption {
type = types.attrsOf settingType;
default = { };
example = literalExpression ''
{
modkey = "Mod4";
workspace_limit = 5;
focus_mode = "manual";
focus_close = "next";
}
'';
description = lib.mdDoc "Spectrwm settings.";
};
bindings = mkOption {
type = types.attrsOf types.str;
default = { };
example = literalExpression ''
{
term = "Mod+Return";
restart = "Mod+Shift+r";
quit = "Mod+Shift+q";
}
'';
description = lib.mdDoc "Spectrwm keybindings.";
};
unbindings = mkOption {
type = types.listOf types.str;
default = [ ];
example = literalExpression ''
[
"MOD+e"
"MOD+f"
"MOD+m"
"MOD+s"
"MOD+u"
"MOD+t"
]
'';
description = lib.mdDoc ''
List of keybindings to disable from default Spectrwm configuration.
'';
};
programs = mkOption {
type = types.attrsOf types.str;
default = { };
example = literalExpression ''
{
term = "alacritty";
search = "dmenu -ip -p 'Window name/id:';
}
'';
description = lib.mdDoc "Spectrwm programs variables.";
};
quirks = mkOption {
type = types.attrsOf types.str;
default = { };
example = literalExpression ''
{
Matplotlib = "FLOAT";
Pavucontrol = "FLOAT";
}
'';
description = lib.mdDoc "Spectrwm quicks (custom window rules).";
};
};
};
config = mkIf cfg.enable {
assertions = [
(hm.assertions.assertPlatform "xsession.windowManager.spectrwm" pkgs
platforms.linux)
];
home.packages = [ cfg.package ];
xsession.windowManager.command = "${cfg.package}/bin/spectrwm";
xdg.configFile."spectrwm/spectrwm.conf".text = ''
# Generated by Home Manager
${concatStringsSep "\n" ( # \
renderedSettings cfg.settings # \
++ renderedPrograms cfg.programs # \
++ renderedQuirks cfg.quirks # \
++ renderedBindings cfg.bindings # \
++ renderedUnbindings cfg.unbindings)}
'';
};
}