core/pkgs/build-support/plugins.nix

31 lines
948 B
Nix
Raw Normal View History

2024-05-02 00:46:19 +00:00
{ lib }:
# helper functions for packaging programs with plugin systems
{
2024-06-30 08:12:46 +00:00
/*
Takes a list of expected plugin names
and compares it to the found plugins given in the file,
one plugin per line.
If the lists differ, the build fails with a nice message.
This is helpful to ensure maintainers dont miss
the addition or removal of a plugin.
*/
2024-05-02 00:46:19 +00:00
diffPlugins = expectedPlugins: foundPluginsFilePath: ''
2024-06-30 08:12:46 +00:00
# sort both lists first
plugins_expected=$(mktemp)
(${lib.concatMapStrings (s: "echo \"${s}\";") expectedPlugins}) \
| sort -u > "$plugins_expected"
plugins_found=$(mktemp)
sort -u "${foundPluginsFilePath}" > "$plugins_found"
2024-05-02 00:46:19 +00:00
2024-06-30 08:12:46 +00:00
if ! mismatches="$(diff -y "$plugins_expected" "$plugins_found")"; then
echo "The the list of expected plugins (left side) doesn't match" \
"the list of plugins we found (right side):" >&2
echo "$mismatches" >&2
exit 1
fi
'';
2024-05-02 00:46:19 +00:00
}