feat: add config option to disable linux desktop entry (#313)

* feat: add config option to disable linux desktop entry

- CLI applications do not need to have desktop entries.
- Additionally, this should also help applications that want to use
  their own Desktop entries for all the packages.
- Currently, there seems to be an option to specify custom desktop entry
  template in debconfig, but not appimage and pacman.

Signed-off-by: Ayush Singh <[email protected]>

* cleanup

* fmt

---------

Signed-off-by: Ayush Singh <[email protected]>
Co-authored-by: Lucas Nogueira <[email protected]>

Author: Ayush1325

.changes/disable-desktop-entry.md

@@ -0,0 +1,6 @@
+---
+"cargo-packager": patch
+"@crabnebula/packager": patch
+---
+
+Added `linux > generateDesktopEntry` config to allow disabling generating a .desktop file on Linux bundles (defaults to true).

bindings/packager/nodejs/schema.json

@@ -248,6 +248,17 @@
         }
       ]
     },
+    "linux": {
+      "description": "Linux-specific configuration",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/LinuxConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "deb": {
       "description": "Debian-specific configuration.",
       "anyOf": [
@@ -792,6 +803,18 @@
       },
       "additionalProperties": false
     },
+    "LinuxConfig": {
+      "description": "Linux configuration",
+      "type": "object",
+      "properties": {
+        "generateDesktopEntry": {
+          "description": "Flag to indicate if desktop entry should be generated.",
+          "default": true,
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
     "DebianConfig": {
       "description": "The Linux Debian configuration.",
       "type": "object",

crates/packager/schema.json

@@ -248,6 +248,17 @@
         }
       ]
     },
+    "linux": {
+      "description": "Linux-specific configuration",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/LinuxConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "deb": {
       "description": "Debian-specific configuration.",
       "anyOf": [
@@ -792,6 +803,18 @@
       },
       "additionalProperties": false
     },
+    "LinuxConfig": {
+      "description": "Linux configuration",
+      "type": "object",
+      "properties": {
+        "generateDesktopEntry": {
+          "description": "Flag to indicate if desktop entry should be generated.",
+          "default": true,
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
     "DebianConfig": {
       "description": "The Linux Debian configuration.",
       "type": "object",

crates/packager/src/config/mod.rs

@@ -840,6 +840,21 @@ impl MacOsConfig {
     }
 }
 
+/// Linux configuration
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
+#[non_exhaustive]
+pub struct LinuxConfig {
+    /// Flag to indicate if desktop entry should be generated.
+    #[serde(
+        default = "default_true",
+        alias = "generate-desktop-entry",
+        alias = "generate_desktop_entry"
+    )]
+    pub generate_desktop_entry: bool,
+}
+
 /// A wix language.
 #[derive(Debug, Clone, Deserialize, Serialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
@@ -1715,6 +1730,8 @@ pub struct Config {
     pub windows: Option<WindowsConfig>,
     /// MacOS-specific configuration.
     pub macos: Option<MacOsConfig>,
+    /// Linux-specific configuration
+    pub linux: Option<LinuxConfig>,
     /// Debian-specific configuration.
     pub deb: Option<DebianConfig>,
     /// AppImage configuration.
@@ -1745,6 +1762,11 @@ impl Config {
         self.macos.as_ref()
     }
 
+    /// Returns the [linux](Config::linux) specific configuration.
+    pub fn linux(&self) -> Option<&LinuxConfig> {
+        self.linux.as_ref()
+    }
+
     /// Returns the [nsis](Config::nsis) specific configuration.
     pub fn nsis(&self) -> Option<&NsisConfig> {
         self.nsis.as_ref()

crates/packager/src/package/app/mod.rs

@@ -317,13 +317,13 @@ fn create_info_plist(
 
     plist.insert("LSRequiresCarbon".into(), true.into());
     plist.insert("NSHighResolutionCapable".into(), true.into());
-    
+
     if let Some(macos_config) = config.macos() {
         if macos_config.background_app {
             plist.insert("LSUIElement".into(), true.into());
         }
     }
-    
+
     if let Some(copyright) = &config.copyright {
         plist.insert("NSHumanReadableCopyright".into(), copyright.clone().into());
     }

crates/packager/src/package/deb/mod.rs

@@ -208,8 +208,14 @@ pub fn generate_data(config: &Config, data_dir: &Path) -> crate::Result<BTreeSet
     tracing::debug!("Generating icons");
     let icons = generate_icon_files(config, data_dir)?;
 
-    tracing::debug!("Generating desktop file");
-    generate_desktop_file(config, data_dir)?;
+    let generate_desktop_entry = config
+        .linux()
+        .map_or(true, |linux| linux.generate_desktop_entry);
+
+    if generate_desktop_entry {
+        tracing::debug!("Generating desktop file");
+        generate_desktop_file(config, data_dir)?;
+    }
 
     Ok(icons)
 }