feat: Add deb.package_name config var (#321)

Co-authored-by: FabianLars-crabnebula <fabianlars@crabnebula.dev>
Co-authored-by: Fabian-Lars <118197967+FabianLars-crabnebula@users.noreply.github.com>

Author: Ayush1325

.changes/deb-package-name.md

@@ -0,0 +1,6 @@
+---
+"cargo-packager": patch
+"@crabnebula/packager": patch
+---
+
+Allow explicitly specifying the Package name for the .deb bundle.

bindings/packager/nodejs/schema.json

@@ -42,7 +42,7 @@
       }
     },
     "identifier": {
-      "description": "The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.).",
+      "description": "The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.).",
       "type": [
         "string",
         "null"
@@ -566,7 +566,7 @@
           ]
         },
         "role": {
-          "description": "The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]",
+          "description": "The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]",
           "default": "editor",
           "allOf": [
             {
@@ -860,6 +860,13 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "packageName": {
+          "description": "Name to use for the `Package` field in the Debian Control file. Defaults to [`Config::product_name`] converted to kebab-case.",
+          "type": [
+            "string",
+            "null"
+          ]
         }
       },
       "additionalProperties": false

bindings/packager/nodejs/src-ts/config.d.ts

@@ -161,7 +161,7 @@ export interface Config {
    */
   binaries?: Binary[];
   /**
-   * The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.).
+   * The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.).
    */
   identifier?: string | null;
   /**
@@ -335,7 +335,7 @@ export interface FileAssociation {
    */
   name?: string | null;
   /**
-   * The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]
+   * The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]
    */
   role?: BundleTypeRole & string;
 }
@@ -493,6 +493,10 @@ export interface DebianConfig {
   files?: {
     [k: string]: string;
   } | null;
+  /**
+   * Name to use for the `Package` field in the Debian Control file. Defaults to [`Config::product_name`] converted to kebab-case.
+   */
+  packageName?: string | null;
 }
 /**
  * The Linux AppImage configuration.

crates/packager/schema.json

@@ -42,7 +42,7 @@
       }
     },
     "identifier": {
-      "description": "The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.).",
+      "description": "The application identifier in reverse domain name notation (e.g. `com.packager.example`). This string must be unique across applications since it is used in some system configurations. This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-), and periods (.).",
       "type": [
         "string",
         "null"
@@ -566,7 +566,7 @@
           ]
         },
         "role": {
-          "description": "The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]",
+          "description": "The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS. Defaults to [`BundleTypeRole::Editor`]",
           "default": "editor",
           "allOf": [
             {
@@ -860,6 +860,13 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "packageName": {
+          "description": "Name to use for the `Package` field in the Debian Control file. Defaults to [`Config::product_name`] converted to kebab-case.",
+          "type": [
+            "string",
+            "null"
+          ]
         }
       },
       "additionalProperties": false

crates/packager/src/config/mod.rs

@@ -75,7 +75,7 @@ pub struct FileAssociation {
     pub description: Option<String>,
     /// The name. Maps to `CFBundleTypeName` on macOS. Defaults to the first item in `ext`
     pub name: Option<String>,
-    /// The app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
+    /// The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
     /// Defaults to [`BundleTypeRole::Editor`]
     #[serde(default)]
     pub role: BundleTypeRole,
@@ -125,7 +125,7 @@ impl FileAssociation {
         self
     }
 
-    /// Set he app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
+    /// Set he app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
     /// Defaults to [`BundleTypeRole::Editor`]
     pub fn role(mut self, role: BundleTypeRole) -> Self {
         self.role = role;
@@ -168,7 +168,7 @@ impl DeepLinkProtocol {
         self
     }
 
-    /// Set he app’s role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
+    /// Set he app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS.
     /// Defaults to [`BundleTypeRole::Editor`]
     pub fn role(mut self, role: BundleTypeRole) -> Self {
         self.role = role;
@@ -231,6 +231,10 @@ pub struct DebianConfig {
     /// List of custom files to add to the deb package.
     /// Maps a dir/file to a dir/file inside the debian package.
     pub files: Option<HashMap<String, String>>,
+    /// Name to use for the `Package` field in the Debian Control file.
+    /// Defaults to [`Config::product_name`] converted to kebab-case.
+    #[serde(alias = "package-name", alias = "package_name")]
+    pub package_name: Option<String>,
 }
 
 impl DebianConfig {
@@ -1645,7 +1649,7 @@ pub struct Config {
     pub binaries: Vec<Binary>,
     /// The application identifier in reverse domain name notation (e.g. `com.packager.example`).
     /// This string must be unique across applications since it is used in some system configurations.
-    /// This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-),
+    /// This string must contain only alphanumeric characters (A-Z, a-z, and 0-9), hyphens (-),
     /// and periods (.).
     #[cfg_attr(feature = "schema", schemars(regex(pattern = r"^[a-zA-Z0-9-\.]*$")))]
     pub identifier: Option<String>,

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

@@ -302,7 +302,13 @@ fn generate_control_file(
     // https://www.debian.org/doc/debian-policy/ch-controlfields.html
     let dest_path = control_dir.join("control");
     let mut file = util::create_file(&dest_path)?;
-    writeln!(file, "Package: {}", AsKebabCase(&config.product_name))?;
+
+    let pkg_name = config
+        .deb()
+        .and_then(|deb| deb.package_name.clone())
+        .unwrap_or_else(|| AsKebabCase(&config.product_name).to_string());
+
+    writeln!(file, "Package: {pkg_name}")?;
     writeln!(file, "Version: {}", &config.version)?;
     writeln!(file, "Architecture: {arch}")?;
     // Installed-Size must be divided by 1024, see https://www.debian.org/doc/debian-policy/ch-controlfields.html#installed-size