feat: add mainBinaryName option (#10977)

* feat: add `mainBinaryName` option

* remove unused imports [skip ci]

* enhance error message [skip ci]

* migrate `mainBinaryName`

* change file

* revert bin src_path

* add link

---------

Co-authored-by: Lucas Nogueira <lucas@tauri.app>

Author: amrbashir

.changes/changelog-path-deb.md

@@ -0,0 +1,5 @@
+---
+'tauri-bundler': 'major:breaking'
+---
+
+Changed changelog file location in `deb` to `usr/share/doc/<product_name>/changelog.gz` instead of `usr/share/doc/<main_binary_name>/changelog.gz`. For tauri v1 users, the path is unchanged as `product_name` and `main_binary_name` used the same value.

.changes/main_binary_name.md

@@ -0,0 +1,8 @@
+---
+"tauri": "patch:feat"
+"tauri-utils": "patch:feat"
+"tauri-cli": "patch:feat"
+"tauri-bundler": "patch:feat"
+---
+
+Add `mainBinaryName` config option to set the file name for the main binary.

.changes/resources-path-deb-rpm.md

@@ -0,0 +1,5 @@
+---
+'tauri-bundler': 'major:breaking'
+---
+
+Changed resources directory location in `deb` and `rpm` to `/usr/lib/<product_name>` instead of `/usr/lib/<main_binary_name>`. For tauri v1 users, the path is unchanged as `product_name` and `main_binary_name` used the same value.

crates/tauri-bundler/src/bundle/linux/appimage.rs

@@ -56,7 +56,7 @@ pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
   // setup data to insert into shell script
   let mut sh_map = BTreeMap::new();
   sh_map.insert("arch", settings.target().split('-').next().unwrap());
-  sh_map.insert("crate_name", settings.main_binary_name());
+  sh_map.insert("product_name", settings.product_name());
   sh_map.insert("appimage_filename", &appimage_filename);
 
   let tauri_tools_path = settings

crates/tauri-bundler/src/bundle/linux/debian.rs

@@ -133,8 +133,8 @@ pub fn generate_data(
 fn generate_changelog_file(settings: &Settings, data_dir: &Path) -> crate::Result<()> {
   if let Some(changelog_src_path) = &settings.deb().changelog {
     let mut src_file = File::open(changelog_src_path)?;
-    let bin_name = settings.main_binary_name();
-    let dest_path = data_dir.join(format!("usr/share/doc/{}/changelog.gz", bin_name));
+    let product_name = settings.product_name();
+    let dest_path = data_dir.join(format!("usr/share/doc/{product_name}/changelog.gz"));
 
     let changelog_file = common::create_file(&dest_path)?;
     let mut gzip_encoder = GzEncoder::new(changelog_file, Compression::new(9));
@@ -306,7 +306,7 @@ fn generate_md5sums(control_dir: &Path, data_dir: &Path) -> crate::Result<()> {
 /// Copy the bundle's resource files into an appropriate directory under the
 /// `data_dir`.
 fn copy_resource_files(settings: &Settings, data_dir: &Path) -> crate::Result<()> {
-  let resource_dir = data_dir.join("usr/lib").join(settings.main_binary_name());
+  let resource_dir = data_dir.join("usr/lib").join(settings.product_name());
   settings.copy_resources(&resource_dir)
 }
 

crates/tauri-bundler/src/bundle/linux/freedesktop.rs

@@ -44,13 +44,14 @@ pub fn list_icon_files(
   data_dir: &Path,
 ) -> crate::Result<BTreeMap<Icon, PathBuf>> {
   let base_dir = data_dir.join("usr/share/icons/hicolor");
+  let main_binary_name = settings.main_binary_name()?;
   let get_dest_path = |width: u32, height: u32, is_high_density: bool| {
     base_dir.join(format!(
       "{}x{}{}/apps/{}.png",
       width,
       height,
       if is_high_density { "@2" } else { "" },
-      settings.main_binary_name()
+      main_binary_name
     ))
   };
   let mut icons = BTreeMap::new();
@@ -97,8 +98,9 @@ pub fn generate_desktop_file(
   custom_template_path: &Option<PathBuf>,
   data_dir: &Path,
 ) -> crate::Result<(PathBuf, PathBuf)> {
-  let bin_name = settings.main_binary_name();
-  let desktop_file_name = format!("{bin_name}.desktop");
+  let bin_name = settings.main_binary_name()?;
+  let product_name = settings.product_name();
+  let desktop_file_name = format!("{product_name}.desktop");
   let path = PathBuf::from("usr/share/applications").join(desktop_file_name);
   let dest_path = PathBuf::from("/").join(&path);
   let file_path = data_dir.join(&path);

crates/tauri-bundler/src/bundle/linux/rpm.rs

@@ -141,12 +141,12 @@ pub fn bundle_project(settings: &Settings) -> crate::Result<Vec<PathBuf>> {
 
   // Add resources
   if settings.resource_files().count() > 0 {
-    let resource_dir = Path::new("/usr/lib").join(settings.main_binary_name());
+    let resource_dir = Path::new("/usr/lib").join(settings.product_name());
     // Create an empty file, needed to add a directory to the RPM package
     // (cf https://github.com/rpm-rs/rpm/issues/177)
     let empty_file_path = &package_dir.join("empty");
     File::create(empty_file_path)?;
-    // Then add the resource directory `/usr/lib/<binary_name>` to the package.
+    // Then add the resource directory `/usr/lib/<product_name>` to the package.
     builder = builder.with_file(
       empty_file_path,
       FileOptions::new(resource_dir.to_string_lossy()).mode(FileMode::Dir { permissions: 0o755 }),

crates/tauri-bundler/src/bundle/linux/templates/appimage

@@ -17,10 +17,10 @@ else
     linuxdeploy_arch="$ARCH"
 fi
 
-mkdir -p "{{crate_name}}.AppDir"
-cp -r ../appimage_deb/data/usr "{{crate_name}}.AppDir"
+mkdir -p "{{product_name}}.AppDir"
+cp -r ../appimage_deb/data/usr "{{product_name}}.AppDir"
 
-cd "{{crate_name}}.AppDir"
+cd "{{product_name}}.AppDir"
 mkdir -p "usr/bin"
 mkdir -p "usr/lib"
 
@@ -56,14 +56,14 @@ find -L /usr/lib* -name libwebkit2gtkinjectedbundle.so -exec mkdir -p "$(dirname
 ( cd "{{tauri_tools_path}}" && ( wget -q -4 -N https://github.com/AppImage/AppImageKit/releases/download/continuous/AppRun-${ARCH} || wget -q -4 -N https://github.com/AppImage/AppImageKit/releases/download/12/AppRun-${ARCH} ) )
 chmod +x "{{tauri_tools_path}}/AppRun-${ARCH}"
 
-# We need AppRun to be installed as {{crate_name}}.AppDir/AppRun.
+# We need AppRun to be installed as {{product_name}}.AppDir/AppRun.
 # Otherwise the linuxdeploy scripts will default to symlinking our main bin instead and will crash on trying to launch.
 cp "{{tauri_tools_path}}/AppRun-${ARCH}" AppRun
 
 cp "{{icon_path}}" .DirIcon
-ln -sf "{{icon_path}}" "{{crate_name}}.png"
+ln -sf "{{icon_path}}" "{{product_name}}.png"
 
-ln -sf "usr/share/applications/{{crate_name}}.desktop" "{{crate_name}}.desktop"
+ln -sf "usr/share/applications/{{product_name}}.desktop" "{{product_name}}.desktop"
 
 cd ..
 
@@ -83,4 +83,4 @@ chmod +x "{{tauri_tools_path}}/linuxdeploy-${linuxdeploy_arch}.AppImage"
 
 dd if=/dev/zero bs=1 count=3 seek=8 conv=notrunc of="{{tauri_tools_path}}/linuxdeploy-${linuxdeploy_arch}.AppImage"
 
-OUTPUT="{{appimage_filename}}" "{{tauri_tools_path}}/linuxdeploy-${linuxdeploy_arch}.AppImage" --appimage-extract-and-run --appdir "{{crate_name}}.AppDir" --plugin gtk ${gst_plugin} --output appimage
+OUTPUT="{{appimage_filename}}" "{{tauri_tools_path}}/linuxdeploy-${linuxdeploy_arch}.AppImage" --appimage-extract-and-run --appdir "{{product_name}}.AppDir" --plugin gtk ${gst_plugin} --output appimage

crates/tauri-bundler/src/bundle/macos/app.rs

@@ -200,7 +200,7 @@ fn create_info_plist(
   plist.insert("CFBundleDisplayName".into(), settings.product_name().into());
   plist.insert(
     "CFBundleExecutable".into(),
-    settings.main_binary_name().into(),
+    settings.main_binary_name()?.into(),
   );
   if let Some(path) = bundle_icon_file {
     plist.insert(

crates/tauri-bundler/src/bundle/macos/ios.rs

@@ -170,7 +170,7 @@ fn generate_info_plist(
   writeln!(
     file,
     "  <key>CFBundleExecutable</key>\n  <string>{}</string>",
-    settings.main_binary_name()
+    settings.main_binary_name()?
   )?;
   writeln!(
     file,