Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions modules/misc/xdg-desktop-entries.nix
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ let
imports = [
(mkRemovedOptionModule [ "extraConfig" ]
"The `extraConfig` option of `xdg.desktopEntries` has been removed following a change in Nixpkgs.")
(mkRemovedOptionModule [ "fileValidation" ]
"Validation of the desktop file is always enabled.")
];
options = {
# Since this module uses the nixpkgs/pkgs/build-support/make-desktopitem function,
Expand Down Expand Up @@ -118,10 +120,35 @@ let
'';
};

fileValidation = mkOption {
type = types.bool;
description = "Whether to validate the generated desktop file.";
default = true;
actions = mkOption {
type = types.attrsOf (types.submodule ({ name, ... }: {
options.name = mkOption {
type = types.str;
default = name;
defaultText = literalExpression "<name>";
description = "Name of the action.";
};
options.exec = mkOption {
type = types.nullOr types.str;
description = "Program to execute, possibly with arguments.";
};
options.icon = mkOption {
type = types.nullOr types.str;
default = null;
description = "Icon to display in file manager, menus, etc.";
};
}));
default = { };
defaultText = literalExpression "{ }";
example = literalExpression ''
{
"New Window" = {
exec = "''${pkgs.firefox}/bin/firefox --new-window %u";
};
}
'';
description =
"The set of actions made available to application launchers.";
};

# Required for the assertions
Expand All @@ -145,7 +172,7 @@ let
inherit name;
inherit (config)
type exec icon comment terminal genericName startupNotify noDisplay
prefersNonDefaultGPU;
prefersNonDefaultGPU actions;
desktopName = config.name;
mimeTypes = optionals (config.mimeType != null) config.mimeType;
categories = optionals (config.categories != null) config.categories;
Expand Down
37 changes: 28 additions & 9 deletions tests/modules/misc/xdg/desktop-entries.nix
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,33 @@ with lib;
startupNotify = false;
noDisplay = false;
prefersNonDefaultGPU = false;
extraConfig = ''
[X-ExtraSection]
Exec=foo -o
'';
settings = {
Keywords = "calc;math";
DBusActivatable = "false";
};
fileValidation = true;
actions = {
"New-Window" = {
name = "New Window";
exec = "test --new-window";
icon = "test";
};
"Default" = { exec = "test --default"; };
};
};
min = { # minimal definition
exec = "test --option";
name = "Test";
};
deprecated = {
exec = "test --option";
name = "Test";
# Deprecated options
fileValidation = true;
extraConfig = ''
[X-ExtraSection]
Exec=foo -o
'';
};
};

#testing that preexisting entries in the store are overridden
Expand All @@ -50,10 +63,16 @@ with lib;

test.asserts.assertions.expected =
let currentFile = toString ./desktop-entries.nix;
in [''
The option definition `extraConfig' in `${currentFile}' no longer has any effect; please remove it.
The `extraConfig` option of `xdg.desktopEntries` has been removed following a change in Nixpkgs.
''];
in [
''
The option definition `fileValidation' in `${currentFile}' no longer has any effect; please remove it.
Validation of the desktop file is always enabled.
''
''
The option definition `extraConfig' in `${currentFile}' no longer has any effect; please remove it.
The `extraConfig` option of `xdg.desktopEntries` has been removed following a change in Nixpkgs.
''
];

nmt.script = ''
assertFileExists home-path/share/applications/full.desktop
Expand Down
10 changes: 10 additions & 0 deletions tests/modules/misc/xdg/desktop-full-expected.desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[Desktop Entry]
Actions=Default;New-Window
Categories=Network;WebBrowser
Comment=My Application
DBusActivatable=false
Expand All @@ -14,3 +15,12 @@ StartupNotify=false
Terminal=true
Type=Application
Version=1.4

[Desktop Action Default]
Exec=test --default
Name=Default

[Desktop Action New-Window]
Exec=test --new-window
Icon=test
Name=New Window