1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 11:36:05 +01:00
home-manager/modules/programs/jq.nix
Marien Zwart a48dd228d9 jq: make colors and package nullable
...and since according to commit
f9b5172d95 the defaults are the upstream
values, default `colors` to null.

Setting JQ_COLORS is just unnecessary environment clutter when using the
default colors.

Although the module now does nothing besides (optionally) installing
`jq` when `colors` is left at its default value, that is still useful:
from a flake with multiple home-manager configurations, some of which
have `jq` provided through other means, setting/forcing
`programs.jq.package` to null is more convenient than conditionally
adding `jq` to `home.packages`.
2025-08-31 18:29:43 -05:00

79 lines
1.7 KiB
Nix

{
config,
lib,
pkgs,
...
}:
let
inherit (lib) mkIf mkOption types;
cfg = config.programs.jq;
colorType = mkOption {
type = types.str;
description = "ANSI color definition";
example = "1;31";
visible = false;
};
colorsType = types.submodule {
options = {
null = colorType;
false = colorType;
true = colorType;
numbers = colorType;
strings = colorType;
arrays = colorType;
objects = colorType;
objectKeys = colorType;
};
};
in
{
options = {
programs.jq = {
enable = lib.mkEnableOption "the jq command-line JSON processor";
package = lib.mkPackageOption pkgs "jq" { nullable = true; };
colors = mkOption {
description = ''
The colors used in colored JSON output, or null to use the defaults.
See the [Colors section](https://jqlang.github.io/jq/manual/#Colors)
of the jq manual.
'';
example = lib.literalExpression ''
{
null = "1;30";
false = "0;31";
true = "0;32";
numbers = "0;36";
strings = "0;33";
arrays = "1;35";
objects = "1;37";
objectKeys = "1;34";
}
'';
default = null;
type = types.nullOr colorsType;
};
};
};
config = mkIf cfg.enable {
home.packages = lib.mkIf (cfg.package != null) [ cfg.package ];
home.sessionVariables =
let
c = cfg.colors;
in
lib.mkIf (c != null) {
JQ_COLORS = "${c.null}:${c.false}:${c.true}:${c.numbers}:${c.strings}:${c.arrays}:${c.objects}:${c.objectKeys}";
};
};
}