forked from mirrors/nixpkgs
6e4096d792
Expose the path to a lesskey file as a module option. This makes it
possible to maintain a single lesskey file, used for both NixOS and
non-nix systems. An example of how this can be done follows.
1. Write a derivation that fetches lesskey from a known location:
{ stdenv, fetchgit }:
stdenv.mkDerivation {
name = "foo";
src = fetchgit { .. };
phases = [ "unpackPhase" "installPhase" ];
installPhase = "mkdir -p $out && cp $src/lesskey $out/lesskey";
}
2. Set programs.less.configFile to the corresponding path:
programs.less = {
enable = true;
configFile = "${pkgs.foo}/lesskey";
};
132 lines
3.6 KiB
Nix
132 lines
3.6 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.programs.less;
|
|
|
|
configText = if (cfg.configFile != null) then (builtins.readFile cfg.configFile) else ''
|
|
#command
|
|
${concatStringsSep "\n"
|
|
(mapAttrsToList (command: action: "${command} ${action}") cfg.commands)
|
|
}
|
|
${if cfg.clearDefaultCommands then "#stop" else ""}
|
|
|
|
#line-edit
|
|
${concatStringsSep "\n"
|
|
(mapAttrsToList (command: action: "${command} ${action}") cfg.lineEditingKeys)
|
|
}
|
|
|
|
#env
|
|
${concatStringsSep "\n"
|
|
(mapAttrsToList (variable: values: "${variable}=${values}") cfg.envVariables)
|
|
}
|
|
'';
|
|
|
|
lessKey = pkgs.runCommand "lesskey"
|
|
{ src = pkgs.writeText "lessconfig" configText; }
|
|
"${pkgs.less}/bin/lesskey -o $out $src";
|
|
|
|
in
|
|
|
|
{
|
|
options = {
|
|
|
|
programs.less = {
|
|
|
|
enable = mkEnableOption "less";
|
|
|
|
configFile = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
example = literalExample "$${pkgs.my-configs}/lesskey";
|
|
description = ''
|
|
Path to lesskey configuration file.
|
|
|
|
<option>configFile</option> takes precedence over <option>commands</option>,
|
|
<option>clearDefaultCommands</option>, <option>lineEditingKeys</option>, and
|
|
<option>envVariables</option>.
|
|
'';
|
|
};
|
|
|
|
commands = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = {};
|
|
example = {
|
|
"h" = "noaction 5\e(";
|
|
"l" = "noaction 5\e)";
|
|
};
|
|
description = "Defines new command keys.";
|
|
};
|
|
|
|
clearDefaultCommands = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Clear all default commands.
|
|
You should remember to set the quit key.
|
|
Otherwise you will not be able to leave less without killing it.
|
|
'';
|
|
};
|
|
|
|
lineEditingKeys = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = {};
|
|
example = {
|
|
"\e" = "abort";
|
|
};
|
|
description = "Defines new line-editing keys.";
|
|
};
|
|
|
|
envVariables = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = {};
|
|
example = {
|
|
LESS = "--quit-if-one-screen";
|
|
};
|
|
description = "Defines environment variables.";
|
|
};
|
|
|
|
lessopen = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s";
|
|
description = ''
|
|
Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed.
|
|
'';
|
|
};
|
|
|
|
lessclose = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = ''
|
|
When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN).
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
environment.systemPackages = [ pkgs.less ];
|
|
|
|
environment.variables = {
|
|
"LESSKEY_SYSTEM" = toString lessKey;
|
|
} // optionalAttrs (cfg.lessopen != null) {
|
|
"LESSOPEN" = cfg.lessopen;
|
|
} // optionalAttrs (cfg.lessclose != null) {
|
|
"LESSCLOSE" = cfg.lessclose;
|
|
};
|
|
|
|
warnings = optional (
|
|
cfg.clearDefaultCommands && (all (x: x != "quit") (attrValues cfg.commands))
|
|
) ''
|
|
config.programs.less.clearDefaultCommands clears all default commands of less but there is no alternative binding for exiting.
|
|
Consider adding a binding for 'quit'.
|
|
'';
|
|
};
|
|
|
|
meta.maintainers = with maintainers; [ johnazoidberg ];
|
|
|
|
}
|