feat(pacman): Add support for Arch Linux Packaging (#137)

* Init Pacman Support * Add Arch Linux packaging * Add PKGBUILD generator * cargo fmt * Update ts config * Remove `data` from path * Add changes file * Rectify Test * Update Docs * Rectify Test * Remove redundant comment Co-authored-by: Amr Bashir <[email protected]> * clone single field instead of whole config * Add file option to pacman config * Update README files * Improve docs * Remove -bin suffix * add back pacman ---------
crabnebula-dev · Jan 24, 2024 · 9bdb953 · 9bdb953
1 parent 4135a84
commit 9bdb953
Show file tree

Hide file tree

Showing 16 changed files with 536 additions and 77 deletions.
diff --git a/.changes/add-pacman-support.md b/.changes/add-pacman-support.md
@@ -0,0 +1,6 @@
+---
+"cargo-packager": minor
+"@crabnebula/packager": minor
+---
+
+Add Arch Linux package manager, `pacman` support for cargo packager.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ It also has a compatible updater through [cargo-packager-updater](./crates/updat
 - Linux
   - Debian package (.deb)
   - AppImage (.AppImage)
+  - Pacman (.tar.gz and PKGBUILD)
 - Windows
   - NSIS (.exe)
   - MSI using WiX Toolset (.msi)

diff --git a/bindings/packager/nodejs/README.md b/bindings/packager/nodejs/README.md
@@ -14,6 +14,7 @@ It also comes with useful addons:
 - Linux
   - Debian package (.deb)
   - AppImage (.AppImage)
+  - Pacman (.tar.gz and PKGBUILD)
 - Windows
   - NSIS (.exe)
   - MSI using WiX Toolset (.msi)

diff --git a/bindings/packager/nodejs/schema.json b/bindings/packager/nodejs/schema.json
@@ -252,6 +252,17 @@
         }
       ]
     },
+    "pacman": {
+      "description": "Pacman configuration.",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/PacmanConfig"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
     "wix": {
       "description": "WiX configuration.",
       "anyOf": [
@@ -434,6 +445,13 @@
           "enum": [
             "appimage"
           ]
+        },
+        {
+          "description": "The Linux Pacman package (.tar.gz and PKGBUILD)",
+          "type": "string",
+          "enum": [
+            "pacman"
+          ]
         }
       ]
     },
@@ -723,7 +741,7 @@
           ]
         },
         "section": {
-          "description": "Define the section in Debian Control file. See : https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections",
+          "description": "Define the section in Debian Control file. See : <https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections>",
           "type": [
             "string",
             "null"
@@ -796,6 +814,73 @@
       },
       "additionalProperties": false
     },
+    "PacmanConfig": {
+      "description": "The Linux pacman configuration.",
+      "type": "object",
+      "properties": {
+        "files": {
+          "description": "List of custom files to add to the pacman package. Maps a dir/file to a dir/file inside the pacman package.",
+          "type": [
+            "object",
+            "null"
+          ],
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "depends": {
+          "description": "List of softwares that must be installed for the app to build and run.\n\nSee : <https://wiki.archlinux.org/title/PKGBUILD#provides>",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "provides": {
+          "description": "Additional packages that are provided by this app.\n\nSee : <https://wiki.archlinux.org/title/PKGBUILD#provides>",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "conflicts": {
+          "description": "Packages that conflict or cause problems with the app. All these packages and packages providing this item will need to be removed\n\nSee : <https://wiki.archlinux.org/title/PKGBUILD#conflicts>",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "replaces": {
+          "description": "Only use if this app replaces some obsolete packages. For example, if you rename any package.\n\nSee : <https://wiki.archlinux.org/title/PKGBUILD#replaces>",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "source": {
+          "description": "Source of the package to be stored at PKGBUILD. PKGBUILD is a bash script, so version can be referred as ${pkgver}",
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     "WixConfig": {
       "description": "The wix format configuration",
       "type": "object",

diff --git a/bindings/packager/nodejs/src-ts/config.d.ts b/bindings/packager/nodejs/src-ts/config.d.ts
@@ -28,7 +28,7 @@ export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
 /**
  * Types of supported packages by [`cargo-packager`](https://docs.rs/cargo-packager).
  */
-export type PackageFormat = "all" | "default" | "app" | "dmg" | "wix" | "nsis" | "deb" | "appimage";
+export type PackageFormat = "all" | "default" | "app" | "dmg" | "wix" | "nsis" | "deb" | "appimage" | "pacman";
 /**
  * The possible app categories. Corresponds to `LSApplicationCategoryType` on macOS and the GNOME desktop categories on Debian.
  */
@@ -264,6 +264,10 @@ export interface Config {
    * AppImage configuration.
    */
   appimage?: AppImageConfig | null;
+  /**
+   * Pacman configuration.
+   */
+  pacman?: PacmanConfig | null;
   /**
    * WiX configuration.
    */
@@ -408,7 +412,7 @@ export interface DebianConfig {
    */
   desktopTemplate?: string | null;
   /**
-   * Define the section in Debian Control file. See : https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
+   * Define the section in Debian Control file. See : <https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections>
    */
   section?: string | null;
   /**
@@ -447,6 +451,45 @@ export interface AppImageConfig {
     [k: string]: string;
   } | null;
 }
+/**
+ * The Linux pacman configuration.
+ */
+export interface PacmanConfig {
+  /**
+   * List of custom files to add to the pacman package. Maps a dir/file to a dir/file inside the pacman package.
+   */
+  files?: {
+    [k: string]: string;
+  } | null;
+  /**
+   * List of softwares that must be installed for the app to build and run.
+   *
+   * See : <https://wiki.archlinux.org/title/PKGBUILD#provides>
+   */
+  depends?: string[] | null;
+  /**
+   * Additional packages that are provided by this app.
+   *
+   * See : <https://wiki.archlinux.org/title/PKGBUILD#provides>
+   */
+  provides?: string[] | null;
+  /**
+   * Packages that conflict or cause problems with the app. All these packages and packages providing this item will need to be removed
+   *
+   * See : <https://wiki.archlinux.org/title/PKGBUILD#conflicts>
+   */
+  conflicts?: string[] | null;
+  /**
+   * Only use if this app replaces some obsolete packages. For example, if you rename any package.
+   *
+   * See : <https://wiki.archlinux.org/title/PKGBUILD#replaces>
+   */
+  replaces?: string[] | null;
+  /**
+   * Source of the package to be stored at PKGBUILD. PKGBUILD is a bash script, so version can be referred as ${pkgver}
+   */
+  source?: string[] | null;
+}
 /**
  * The wix format configuration
  */

diff --git a/crates/packager/Cargo.toml b/crates/packager/Cargo.toml
@@ -62,7 +62,7 @@ walkdir = "2"
 os_pipe = "1"
 minisign = "0.7"
 tar = { workspace = true }
-libflate = "2.0"
+flate2 = "1.0"
 strsim = "0.10"
 schemars = { workspace = true, optional = true }
 native-tls = { version = "0.2", optional = true }

diff --git a/crates/packager/README.md b/crates/packager/README.md
@@ -16,6 +16,7 @@ It also comes with useful addons:
 - Linux
   - Debian package (.deb)
   - AppImage (.AppImage)
+  - Pacman (.tar.gz and PKGBUILD)
 - Windows
   - NSIS (.exe)
   - MSI using WiX Toolset (.msi)