fix: keep original productName for .desktop Name field, closes #2295 (#2384)

lucasfernog · web-flow · commit 3f039cb8a308 · 2021-08-10T16:02:46.000-03:00
diff --git a/.changes/linux-app-name.md b/.changes/linux-app-name.md
@@ -0,0 +1,6 @@
+---
+"cli.rs": patch
+"tauri-bundler": patch
+---
+
+Only convert package name and binary name to kebab-case, keeping the `.desktop` `Name` field with the original configured value.
diff --git a/.changes/product-name-original.md b/.changes/product-name-original.md
@@ -0,0 +1,6 @@
+---
+"tauri": patch
+"tauri-utils": patch
+---
+
+Keep original value on `config > package > productName` on Linux (previously converted to kebab-case).
diff --git a/core/tauri-utils/Cargo.toml b/core/tauri-utils/Cargo.toml
@@ -22,8 +22,5 @@ html5ever = "0.25"
 proc-macro2 = { version = "1.0", optional = true }
 quote = { version = "1.0", optional = true }
 
-[target."cfg(target_os = \"linux\")".dependencies]
-heck = "0.3"
-
 [features]
 build = [ "proc-macro2", "quote" ]
diff --git a/core/tauri-utils/src/lib.rs b/core/tauri-utils/src/lib.rs
@@ -27,13 +27,7 @@ impl PackageInfo {
   /// Returns the application package name.
   /// On macOS and Windows it's the `name` field, and on Linux it's the `name` in `kebab-case`.
   pub fn package_name(&self) -> String {
-    #[cfg(target_os = "linux")]
-    {
-      use heck::KebabCase;
-      self.name.to_kebab_case()
-    }
-    #[cfg(not(target_os = "linux"))]
-    return self.name.clone();
+    self.name.clone()
   }
 }
 
diff --git a/examples/api/public/build/bundle.js b/examples/api/public/build/bundle.js
diff --git a/examples/api/public/build/bundle.js.map b/examples/api/public/build/bundle.js.map
diff --git a/tooling/bundler/Cargo.toml b/tooling/bundler/Cargo.toml
@@ -53,6 +53,9 @@ hex = "0.4"
 chrono = "0.4"
 dirs-next = "2.0"
 
+[target."cfg(target_os = \"linux\")".dependencies]
+heck = "0.3"
+
 [lib]
 name = "tauri_bundler"
 path = "src/lib.rs"
diff --git a/tooling/bundler/src/bundle/linux/debian.rs b/tooling/bundler/src/bundle/linux/debian.rs
@@ -26,6 +26,7 @@ use super::super::common;
 use crate::Settings;
 
 use anyhow::Context;
+use heck::KebabCase;
 use image::{self, png::PngDecoder, GenericImageView, ImageDecoder};
 use libflate::gzip;
 use std::process::{Command, Stdio};
@@ -251,7 +252,7 @@ fn generate_control_file(
   writeln!(
     &mut file,
     "Package: {}",
-    str::replace(settings.product_name(), " ", "-").to_ascii_lowercase()
+    settings.product_name().to_kebab_case().to_ascii_lowercase()
   )?;
   writeln!(&mut file, "Version: {}", settings.version_string())?;
   writeln!(&mut file, "Architecture: {}", arch)?;
diff --git a/tooling/cli.rs/Cargo.lock b/tooling/cli.rs/Cargo.lock
diff --git a/tooling/cli.rs/Cargo.toml b/tooling/cli.rs/Cargo.toml
@@ -54,6 +54,9 @@ encode_unicode = "0.3"
 [target."cfg(target_os = \"linux\")".dependencies]
 heck = "0.3"
 
+[target."cfg(target_os = \"linux\")".build-dependencies]
+heck = "0.3"
+
 [build-dependencies]
 schemars = "0.8"
 serde = { version = "1.0", features = [ "derive" ] }
diff --git a/tooling/cli.rs/config_definition.rs b/tooling/cli.rs/config_definition.rs
@@ -4,6 +4,8 @@
 
 #![allow(clippy::field_reassign_with_default)]
 
+#[cfg(target_os = "linux")]
+use heck::KebabCase;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_json::Value as JsonValue;
@@ -103,6 +105,20 @@ pub struct PackageConfig {
   pub version: Option<String>,
 }
 
+impl PackageConfig {
+  #[allow(dead_code)]
+  pub fn binary_name(&self) -> Option<String> {
+    #[cfg(target_os = "linux")]
+    {
+      self.product_name.as_ref().map(|n| n.to_kebab_case())
+    }
+    #[cfg(not(target_os = "linux"))]
+    {
+      self.product_name.clone()
+    }
+  }
+}
+
 #[skip_serializing_none]
 #[derive(Debug, Default, PartialEq, Clone, Deserialize, Serialize, JsonSchema)]
 #[serde(rename_all = "camelCase", deny_unknown_fields)]
diff --git a/tooling/cli.rs/src/build.rs b/tooling/cli.rs/src/build.rs
@@ -3,6 +3,8 @@
 // SPDX-License-Identifier: MIT
 
 use anyhow::Context;
+#[cfg(target_os = "linux")]
+use heck::KebabCase;
 use tauri_bundler::bundle::{bundle_project, PackageType};
 
 use crate::helpers::{
@@ -139,8 +141,15 @@ impl Build {
           out_dir.join(format!("{}.exe", product_name)),
         )
       };
-      #[cfg(not(windows))]
+      #[cfg(target_os = "macos")]
       let (bin_path, product_path) = { (out_dir.join(bin_name), out_dir.join(product_name)) };
+      #[cfg(target_os = "linux")]
+      let (bin_path, product_path) = {
+        (
+          out_dir.join(bin_name),
+          out_dir.join(product_name.to_kebab_case()),
+        )
+      };
       rename(&bin_path, &product_path).with_context(|| {
         format!(
           "failed to rename `{}` to `{}`",
diff --git a/tooling/cli.rs/src/helpers/config.rs b/tooling/cli.rs/src/helpers/config.rs
@@ -3,8 +3,6 @@
 // SPDX-License-Identifier: MIT
 
 use anyhow::Context;
-#[cfg(target_os = "linux")]
-use heck::KebabCase;
 use json_patch::merge;
 use once_cell::sync::Lazy;
 use serde_json::Value as JsonValue;
@@ -99,12 +97,7 @@ fn get_internal(merge_config: Option<&str>, reload: bool) -> crate::Result<Confi
     merge(&mut config, &platform_config);
   }
 
-  #[allow(unused_mut)]
-  let mut config: Config = serde_json::from_value(config)?;
-  #[cfg(target_os = "linux")]
-  if let Some(product_name) = config.package.product_name.as_mut() {
-    *product_name = product_name.to_kebab_case();
-  }
+  let config: Config = serde_json::from_value(config)?;
   set_var("TAURI_CONFIG", serde_json::to_string(&config)?);
   *config_handle().lock().unwrap() = Some(config);
 
diff --git a/tooling/cli.rs/src/interface/rust.rs b/tooling/cli.rs/src/interface/rust.rs
@@ -11,6 +11,8 @@ use std::{
 };
 
 use anyhow::Context;
+#[cfg(target_os = "linux")]
+use heck::KebabCase;
 use serde::Deserialize;
 
 use crate::helpers::{app_paths::tauri_dir, config::Config, manifest::Manifest};
@@ -212,8 +214,7 @@ impl AppSettings {
             BundleBinary::new(
               config
                 .package
-                .product_name
-                .clone()
+                .binary_name()
                 .unwrap_or_else(|| binary.name.clone()),
               true,
             )
@@ -244,16 +245,15 @@ impl AppSettings {
     if let Some(default_run) = self.package_settings.default_run.as_ref() {
       match binaries.iter_mut().find(|bin| bin.name() == default_run) {
         Some(bin) => {
-          if let Some(product_name) = config.package.product_name.clone() {
-            bin.set_name(product_name);
+          if let Some(bin_name) = config.package.binary_name() {
+            bin.set_name(bin_name);
           }
         }
         None => {
           binaries.push(BundleBinary::new(
             config
               .package
-              .product_name
-              .clone()
+              .binary_name()
               .unwrap_or_else(|| default_run.to_string()),
             true,
           ));
@@ -263,6 +263,9 @@ impl AppSettings {
 
     match binaries.len() {
       0 => binaries.push(BundleBinary::new(
+        #[cfg(target_os = "linux")]
+        self.package_settings.product_name.to_kebab_case(),
+        #[cfg(not(target_os = "linux"))]
         self.package_settings.product_name.clone(),
         true,
       )),

Original file line number	Diff line number	Diff line change
`@@ -27,13 +27,7 @@ impl PackageInfo {`
`27`	`27`	`/// Returns the application package name.`
`28`	`28`	/// On macOS and Windows it's the `name` field, and on Linux it's the `name` in `kebab-case`.
`29`	`29`	`pub fn package_name(&self) -> String {`
`30`		`- #[cfg(target_os = "linux")]`
`31`		`- {`
`32`		`- use heck::KebabCase;`
`33`		`- self.name.to_kebab_case()`
`34`		`- }`
`35`		`- #[cfg(not(target_os = "linux"))]`
`36`		`- return self.name.clone();`
	`30`	`+ self.name.clone()`
`37`	`31`	`}`
`38`	`32`	`}`
`39`	`33`