1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-27 04:09:47 +01:00
home-manager/modules/programs/readline.nix
Emily 9f9e277b60 treewide: remove now-redundant lib.mdDoc calls
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

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 \
      --strip {} +
    $ ./format
2023-07-17 18:49:09 +01:00

84 lines
2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.readline;
mkSetVariableStr = n: v:
let
mkValueStr = v:
if v == true then
"on"
else if v == false then
"off"
else if isInt v then
toString v
else if isString v then
v
else
abort ("values ${toPretty v} is of unsupported type");
in "set ${n} ${mkValueStr v}";
mkBindingStr = k: v:
let
isKeynameNotKeyseq = k:
builtins.elem (builtins.head (lib.splitString "-" (toLower k))) [
"control"
"meta"
];
in if isKeynameNotKeyseq k then "${k}: ${v}" else ''"${k}": ${v}'';
in {
options.programs.readline = {
enable = mkEnableOption "readline";
bindings = mkOption {
default = { };
type = types.attrsOf types.str;
example = literalExpression ''
{ "\\C-h" = "backward-kill-word"; }
'';
description = "Readline bindings.";
};
variables = mkOption {
type = with types; attrsOf (either str (either int bool));
default = { };
example = { expand-tilde = true; };
description = ''
Readline customization variable assignments.
'';
};
includeSystemConfig = mkOption {
type = types.bool;
default = true;
description = "Whether to include the system-wide configuration.";
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Configuration lines appended unchanged to the end of the
{file}`~/.inputrc` file.
'';
};
};
config = mkIf cfg.enable {
home.file.".inputrc".text = let
configStr = concatStringsSep "\n"
(optional cfg.includeSystemConfig "$include /etc/inputrc"
++ mapAttrsToList mkSetVariableStr cfg.variables
++ mapAttrsToList mkBindingStr cfg.bindings);
in ''
# Generated by Home Manager.
${configStr}
${cfg.extraConfig}
'';
};
}