51cc553307
- New parameter `extraDesktopEntries` to easily add some less usual entries to the desktop file - Rewrite of the core logic. Instead of a key-value-list, use an attribute set with nullable values to make it overridable - Added some comments - Some cosmetic/readability code refactors - I didn't like the doubly nested strings around the `fileValidation`
58 lines
2.1 KiB
Nix
58 lines
2.1 KiB
Nix
{ lib, runCommandLocal, desktop-file-utils }:
|
|
|
|
# See https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html
|
|
{ name # The name of the desktop file
|
|
, type ? "Application"
|
|
, exec
|
|
, icon ? null
|
|
, comment ? null
|
|
, terminal ? "false"
|
|
, desktopName # The name of the application
|
|
, genericName ? null
|
|
, mimeType ? null
|
|
, categories ? null
|
|
, startupNotify ? null
|
|
, extraDesktopEntries ? {} # Extra key-value pairs to add to the [Desktop Entry] section. This may override other values
|
|
, extraEntries ? "" # Extra configuration. Will be appended to the end of the file and may thus contain extra sections
|
|
, fileValidation ? true # whether to validate resulting desktop file.
|
|
}:
|
|
|
|
let
|
|
# like builtins.toString, but null -> null instead of null -> ""
|
|
nullableToString = value: if value == null then null else builtins.toString value;
|
|
|
|
# The [Desktop entry] section of the desktop file, as attribute set.
|
|
mainSection = {
|
|
"Type" = toString type;
|
|
"Exec" = (nullableToString exec);
|
|
"Icon" = (nullableToString icon);
|
|
"Comment" = (nullableToString comment);
|
|
"Terminal" = (nullableToString terminal);
|
|
"Name" = toString name;
|
|
"GenericName" = (nullableToString genericName);
|
|
"MimeType" = (nullableToString mimeType);
|
|
"Categories" = (nullableToString categories);
|
|
"StartupNotify" = (nullableToString startupNotify);
|
|
} // extraDesktopEntries;
|
|
|
|
# Map all entries to a list of lines
|
|
desktopFileStrings =
|
|
["[Desktop Entry]"]
|
|
++ builtins.filter
|
|
(v: v != null)
|
|
(lib.mapAttrsToList
|
|
(name: value: if value != null then "${name}=${value}" else null)
|
|
mainSection
|
|
)
|
|
++ (if extraEntries == "" then [] else ["${extraEntries}"]);
|
|
in
|
|
runCommandLocal "${name}.desktop" {}
|
|
(''
|
|
mkdir -p "$out/share/applications"
|
|
cat > "$out/share/applications/${name}.desktop" <<EOF
|
|
${builtins.concatStringsSep "\n" desktopFileStrings}
|
|
EOF
|
|
'' + lib.optionalString fileValidation ''
|
|
echo "Running desktop-file validation"
|
|
${desktop-file-utils}/bin/desktop-file-validate "$out/share/applications/${name}.desktop"
|
|
'')
|