nixpkgs/pkgs/build-support/compress-drv/default.nix
Philip Taron fcefb0a17c
Merge pull request #332558 from motiejus/compressDrv
compressDrv: get rid of unneeded extra params
2024-08-05 14:58:06 -07:00

79 lines
1.9 KiB
Nix

{
lib,
xorg,
runCommand,
}:
/**
Compresses files of a given derivation, and returns a new derivation with
compressed files
# Inputs
`formats` ([String])
: List of file extensions to compress. Example: `["txt" "svg" "xml"]`.
`compressors` ( { ${fileExtension} :: String })
: Map a desired extension (e.g. `gz`) to a compress program.
The compressor program that will be executed to get the `COMPRESSOR` extension.
The program should have a single " {}", which will be the replaced with the
target filename.
Compressor must:
- read symlinks (thus --force is needed to gzip, zstd, xz).
- keep the original file in place (--keep).
# Type
```
compressDrv :: Derivation -> { formats :: [ String ]; compressors :: { ${fileExtension} :: String; } } -> Derivation
```
# Examples
:::{.example}
## `pkgs.compressDrv` usage example
```
compressDrv pkgs.spdx-license-list-data.json {
formats = ["json"];
compressors = {
"json" = "${zopfli}/bin/zopfli --keep {}";
};
}
=>
«derivation /nix/store/...-spdx-license-list-data-3.24.0-compressed.drv»
```
See also pkgs.compressDrvWeb, which is a wrapper on top of compressDrv, for broader usage
examples.
:::
*/
drv:
{ formats, compressors }:
let
validProg =
ext: prog:
let
matches = (builtins.length (builtins.split "\\{}" prog) - 1) / 2;
in
lib.assertMsg (
matches == 1
) "compressor ${ext} needs to have exactly one '{}', found ${builtins.toString matches}";
mkCmd =
ext: prog:
assert validProg ext prog;
''
find -L $out -type f -regextype posix-extended -iregex '.*\.(${formatsPipe})' -print0 \
| xargs -0 -P$NIX_BUILD_CORES -I{} ${prog}
'';
formatsPipe = builtins.concatStringsSep "|" formats;
in
runCommand "${drv.name}-compressed" { } ''
mkdir $out
(cd $out; ${xorg.lndir}/bin/lndir ${drv})
${lib.concatStringsSep "\n\n" (lib.mapAttrsToList mkCmd compressors)}
''