tvl-depot/users/sterni/nix/build/toPlainText/default.nix
sterni 8f13435020 feat(sterni/nix/build): check in toPlainText
This is a little helper which tries to render different input files into
a fancier, human readable plain text form. This is quite useful to
gether with build.gopherHole.

Change-Id: Ibe0050fa6a55e85745127a287bba0febeeb75849
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12874
Reviewed-by: sterni <sternenseemann@systemli.org>
Tested-by: BuildkiteCI
Autosubmit: sterni <sternenseemann@systemli.org>
2024-12-07 01:06:28 +00:00

56 lines
1 KiB
Nix

{ pkgs, depot, lib, ... }:
{ fmt ? null
, passthru ? { }
, ...
}@args:
let
inherit (depot.nix) getBins utils;
bins = getBins pkgs.lowdown [
"lowdown"
] // getBins pkgs.mandoc [
"mandoc"
] // getBins pkgs.gnused [
"sed"
];
actions = {
mdoc = ''
${bins.mandoc} -T utf8 "${thing}" > "$out"
'';
# Use lowdown's terminal target, but strip all ANSI SGR escape sequences
markdown = ''
${bins.lowdown} -Tterm "${thing}" \
| ${bins.sed} -e 's|\\x1b\\[[;0-9]*m||g' \
> "$out"
'';
plain = ''
cp --reflink=auto "${thing}" "$out"
'';
};
thingType = builtins.head (
builtins.filter (x: x != null) (
builtins.map (t: if args ? ${t} then t else null) (
builtins.attrNames actions
)
)
);
thing = args.${thingType};
name = args.name or utils.storePathName thing;
in
pkgs.runCommand name
{
inherit passthru;
}
(
actions.${thingType} + lib.optionalString (fmt != null) ''
fmt -w "${lib.escapeShellArg (toString fmt)}" "$out"
''
)