feat: add config option to control excluded libs in AppImage (#148)

* Added config feature to control excluded libs in build_appimage.sh

Co-authored-by: Janrupf <[email protected]>

* Update .changes/excluded-libs-appiamge.md

* Update crates/packager/src/config/mod.rs

Co-authored-by: Lucas Nogueira <[email protected]>

---------

Co-authored-by: Janrupf <[email protected]>

.changes/excluded-libs-appiamge.md

@@ -0,0 +1,6 @@
+---
+"cargo-packager": minor
+"@crabnebula/packager": minor
+---
+
+Added config option to control excluded libs when packaging AppImage

bindings/packager/nodejs/schema.json

@@ -810,6 +810,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "excludedLibs": {
+          "description": "List of globs of libraries to exclude from the final APpImage. For example, to exclude libnss3.so, you'd specify `libnss3*`",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false

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

@@ -450,6 +450,10 @@ export interface AppImageConfig {
   linuxdeployPlugins?: {
     [k: string]: string;
   } | null;
+  /**
+   * List of globs of libraries to exclude from the final APpImage. For example, to exclude libnss3.so, you'd specify `libnss3*`
+   */
+  excludedLibs?: string[] | null;
 }
 /**
  * The Linux pacman configuration.

crates/packager/schema.json

@@ -810,6 +810,16 @@
           "additionalProperties": {
             "type": "string"
           }
+        },
+        "excludedLibs": {
+          "description": "List of globs of libraries to exclude from the final APpImage. For example, to exclude libnss3.so, you'd specify `libnss3*`",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": false

crates/packager/src/config/mod.rs

@@ -267,6 +267,10 @@ pub struct AppImageConfig {
     /// you'd specify `gtk` as the key and its url as the value.
     #[serde(alias = "linuxdeploy-plugins", alias = "linuxdeploy_plugins")]
     pub linuxdeploy_plugins: Option<HashMap<String, String>>,
+    /// List of globs of libraries to exclude from the final AppImage.
+    /// For example, to exclude libnss3.so, you'd specify `libnss3*`
+    #[serde(alias = "excluded-libraries", alias = "excluded_libraries")]
+    pub excluded_libs: Option<Vec<String>>,
 }
 
 impl AppImageConfig {

crates/packager/src/package/appimage/appimage

@@ -41,4 +41,4 @@ cd ..
 # and so appimagelauncher doesn't inject itself and the binary runs directly
 dd if=/dev/zero bs=1 count=3 seek=8 conv=notrunc of="{{packager_tools_path}}/linuxdeploy-{{linuxdeploy_arch}}.AppImage"
 
-OUTPUT="{{appimage_path}}" "{{packager_tools_path}}/linuxdeploy-{{linuxdeploy_arch}}.AppImage" --appimage-extract-and-run --appdir "{{app_name}}.AppDir" {{linuxdeploy_plugins}} --output appimage
+OUTPUT="{{appimage_path}}" "{{packager_tools_path}}/linuxdeploy-{{linuxdeploy_arch}}.AppImage" --appimage-extract-and-run --appdir "{{app_name}}.AppDir" {{linuxdeploy_plugins}} {{excluded_libs}} --output appimage

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

@@ -136,6 +136,16 @@ pub(crate) fn package(ctx: &Context) -> crate::Result<Vec<PathBuf>> {
         .join(" ");
     sh_map.insert("linuxdeploy_plugins", to_json(linuxdeploy_plugins));
 
+    let excluded_libraries = config
+        .appimage()
+        .and_then(|a| a.excluded_libs.clone())
+        .unwrap_or_default()
+        .into_iter()
+        .map(|library| format!("--exclude-library {}", library))
+        .collect::<Vec<_>>()
+        .join(" ");
+    sh_map.insert("excluded_libs", to_json(excluded_libraries));
+
     let larger_icon = icons
         .iter()
         .filter(|i| i.width == i.height)