nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

bat: allow setting themes/syntaxes without IFD

Browse source 
The way the `bat` module is currently written makes it essentially
impossible to use themes and syntaxes without IFD, since you must
provide the contents as string, instead of just giving a path to be
linked.

With this change, setting themes/syntaxes by-string will start issuing
warnings, and a new attribute model is added, lightly inspired by how
`programs.zsh.plugins` avoided this issue.
This commit is contained in:
Bernardo Meurer 2023-10-05 16:01:18 -04:00 • committed by Robert Helgesson
parent 68f7d8c0fb
commit 44635279a0
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
4 changed files with 164 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

124
modules/programs/bat.nix
View file

@ -43,16 +43,33 @@ in {
};
themes = mkOption {
type = types.attrsOf types.lines;
type = types.attrsOf (types.either types.lines (types.submodule {
options = {
src = mkOption {
type = types.path;
description = "Path to the theme folder.";
};
file = mkOption {
type = types.nullOr types.str;
default = null;
description =
"Subpath of the theme file within the source, if needed.";
};
};
}));
default = { };
example = literalExpression ''
{
dracula = builtins.readFile (pkgs.fetchFromGitHub {
owner = "dracula";
repo = "sublime"; # Bat uses sublime syntax for its themes
rev = "26c57ec282abcaa76e57e055f38432bd827ac34e";
sha256 = "019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv";
} + "/Dracula.tmTheme");
dracula = {
src = pkgs.fetchFromGitHub {
owner = "dracula";
repo = "sublime"; # Bat uses sublime syntax for its themes
rev = "26c57ec282abcaa76e57e055f38432bd827ac34e";
sha256 = "019hfl4zbn4vm4154hh3bwk6hm7bdxbr1hdww83nabxwjn99ndhv";
};
file = "Dracula.tmTheme";
};
}
'';
description = ''
@ -61,43 +78,84 @@ in {
};
syntaxes = mkOption {
type = types.attrsOf types.lines;
type = types.attrsOf (types.either types.lines (types.submodule {
options = {
src = mkOption {
type = types.path;
description = "Path to the syntax folder.";
};
file = mkOption {
type = types.nullOr types.str;
default = null;
description =
"Subpath of the syntax file within the source, if needed.";
};
};
}));
default = { };
example = literalExpression ''
{
syntaxes.gleam = builtins.readFile (pkgs.fetchFromGitHub {
owner = "molnarmark";
repo = "sublime-gleam";
rev = "2e761cdb1a87539d827987f997a20a35efd68aa9";
hash = "sha256-Zj2DKTcO1t9g18qsNKtpHKElbRSc9nBRE2QBzRn9+qs=";
} + "/syntax/gleam.sublime-syntax");
gleam = {
src = pkgs.fetchFromGitHub {
owner = "molnarmark";
repo = "sublime-gleam";
rev = "2e761cdb1a87539d827987f997a20a35efd68aa9";
hash = "sha256-Zj2DKTcO1t9g18qsNKtpHKElbRSc9nBRE2QBzRn9+qs=";
};
file = "syntax/gleam.sublime-syntax";
};
}
'';
description = ''
Additional syntaxes to provide.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ package ] ++ cfg.extraPackages;
config = mkIf cfg.enable (mkMerge [
(mkIf (any isString (attrValues cfg.themes)) {
warnings = [''
Using programs.bat.themes as a string option is deprecated and will be
removed in the future. Please change to using it as an attribute set
instead.
''];
})
(mkIf (any isString (attrValues cfg.syntaxes)) {
warnings = [''
Using programs.bat.syntaxes as a string option is deprecated and will be
removed in the future. Please change to using it as an attribute set
instead.
''];
})
{
home.packages = [ package ] ++ cfg.extraPackages;
xdg.configFile = mkMerge ([{
"bat/config" =
mkIf (cfg.config != { }) { text = toConfigFile cfg.config; };
}] ++ flip mapAttrsToList cfg.themes
(name: body: { "bat/themes/${name}.tmTheme" = { text = body; }; })
++ flip mapAttrsToList cfg.syntaxes (name: body: {
"bat/syntaxes/${name}.sublime-syntax" = { text = body; };
}));
xdg.configFile = mkMerge ([({
"bat/config" =
mkIf (cfg.config != { }) { text = toConfigFile cfg.config; };
})] ++ (flip mapAttrsToList cfg.themes (name: val: {
"bat/themes/${name}.tmTheme" = if isString val then {
text = val;
} else {
source =
if isNull val.file then "${val.src}" else "${val.src}/${val.file}";
};
})) ++ (flip mapAttrsToList cfg.syntaxes (name: val: {
"bat/syntaxes/${name}.sublime-syntax" = if isString val then {
text = val;
} else {
source =
if isNull val.file then "${val.src}" else "${val.src}/${val.file}";
};
})));
home.activation.batCache = hm.dag.entryAfter [ "linkGeneration" ] ''
(
export XDG_CACHE_HOME=${escapeShellArg config.xdg.cacheHome}
$VERBOSE_ECHO "Rebuilding bat theme cache"
$DRY_RUN_CMD ${lib.getExe package} cache --build
)
'';
};
home.activation.batCache = hm.dag.entryAfter [ "linkGeneration" ] ''
(
export XDG_CACHE_HOME=${escapeShellArg config.xdg.cacheHome}
$VERBOSE_ECHO "Rebuilding bat theme cache"
$DRY_RUN_CMD ${lib.getExe package} cache --build
)
'';
}
]);
}