Electron Snapcraft 指南 (Linux)

本指南提供了有关如何包装你的 Electron 应用程序的任何 Snapcraft 环境, 包括 Ubuntu 软件中心的信息。

背景和要求

与更广泛的 Linux 社区一起, 规范旨在解决 snapcraft 项目中的许多常见的软件安装问题。 Snaps 是容器化的软件包, 包括所需的依赖项、自动更新和对所有主要 Linux 发行版的工作, 而无需进行系统修改。

创建 .snap 文件有三种方法:

1) 使用 Electron Forge 或 electron-builder，这两种工具都提供开箱即用的 snap 支持。 这是最简单的选择。 

2) 使用 electron-installer-snap, 它采用 electron-packager 的输出。 

3) 使用已经创建的 .deb 包。

在某些情况下，您需要安装 snapcraft 工具。 安装特定发行版的 snapcraft 的指南在这里能看到。

使用 electron-installer-snap

该模块的工作方式类似于 electron-winstaller 和类似模块，因为它的范围仅限于构建 snap 包。你可以这样安装:

npm install --save-dev electron-installer-snap

步骤 1: 打包你的 Electron 应用程序

使用 electron-packager（或类似工具）打包应用程序。确保删除最终应用程序中不需要的 ​node_modules​，因为实际上不需要的任何模块都会增加应用程序的大小。

结构输出应该看起来大致像这样:

.
└── dist
    └── app-linux-x64
        ├── LICENSE
        ├── LICENSES.chromium.html
        ├── content_shell.pak
        ├── app
        ├── icudtl.dat
        ├── libgcrypt.so.11
        ├── libnode.so
        ├── locales
        ├── resources
        ├── v8_context_snapshot.bin
        └── version

步骤 2: 运行 electron-installer-snap

从在其 PATH 中包含 snapcraft 的终端，运行带有唯一必需参数 ​--src​ 的 ​electron-installer-snap​，这是第一步中创建的打包 Electron 应用程序的位置。

npx electron-installer-snap --src=out/myappname-linux-x64

如果您有现有的构建管道，则可以以编程方式使用 electron-installer-snap。有关详细信息，请参阅 Snapcraft API 文档。

const snap = require('electron-installer-snap')

snap(options)
  .then(snapPath => console.log(`Created snap at ${snapPath}!`))

在electron-packager中使用sapcraft

第 1 步：创建示例 Snapcraft 项目

创建你的项目目录并将以下内容添加到 snap/snapcraft.yaml：

name: electron-packager-hello-world
version: '0.1'
summary: Hello World Electron app
description: |
  Simple Hello World Electron app as an example
base: core18
confinement: strict
grade: stable

apps:
  electron-packager-hello-world:
    command: electron-quick-start/electron-quick-start --no-sandbox
    extensions: [gnome-3-34]
    plugs:
    - browser-support
    - network
    - network-bind
    environment:
      # Correct the TMPDIR path for Chromium Framework/Electron to ensure
      # libappindicator has readable resources.
      TMPDIR: $XDG_RUNTIME_DIR

parts:
  electron-quick-start:
    plugin: nil
    source: https://github.com/electron/electron-quick-start.git
    override-build: |
        npm install electron electron-packager
        npx electron-packager . --overwrite --platform=linux --output=release-build --prune=true
        cp -rv ./electron-quick-start-linux-* $SNAPCRAFT_PART_INSTALL/electron-quick-start
    build-snaps:
    - node/14/stable
    build-packages:
    - unzip
    stage-packages:
    - libnss3
    - libnspr4

如果要将此示例应用于现有项目：

• 替代 source: https://github.com/electron/electron-quick-start.git</0 > 为 <code>source: ...
• 替代所有的 electron-quick-start 为你的项目名称。

第 2 步：构建 snap

$ snapcraft

<output snipped>
Snapped electron-packager-hello-world_0.1_amd64.snap

第 3 步：安装 snap

sudo snap install electron-packager-hello-world_0.1_amd64.snap --dangerous

第 4 步：运行 snap

electron-packager-hello-world

使用一个现有的 Debian 包

Snapcraft 能够获取现有的 .deb 文件并将其转换为 .snap 文件。快照的创建是使用描述源、依赖项、描述和其他核心构建块的 snapcraft.yaml 文件配置的。

步骤 1: 创建一个 Debian 包

如果您还没有 .deb 包，使用 electron-installer-snap 可能是创建 snap 包的更简单途径。然而，存在多种创建 Debian 软件包的解决方案，包括 Electron Forge、electron-builder 或 electron-installer-debian。

步骤 2: 创建一个 snapcraft.yaml

有关可用配置选项的更多信息，请参阅有关 snapcraft 语法的文档。让我们看一个例子：

name: myApp
version: '2.0.0'
summary: A little description for the app.
description: |
 You know what? This app is amazing! It does all the things
 for you. Some say it keeps you young, maybe even happy.

grade: stable
confinement: classic

parts:
  slack:
    plugin: dump
    source: my-deb.deb
    source-type: deb
    after:
      - desktop-gtk3
    stage-packages:
      - libasound2
      - libnotify4
      - libnspr4
      - libnss3
      - libpcre3
      - libpulse0
      - libxss1
      - libxtst6
  electron-launch:
    plugin: dump
    source: files/
    prepare: |
      chmod +x bin/electron-launch

apps:
  myApp:
    command: bin/electron-launch $SNAP/usr/lib/myApp/myApp
    desktop: usr/share/applications/myApp.desktop
    # Correct the TMPDIR path for Chromium Framework/Electron to ensure
    # libappindicator has readable resources.
    environment:
      TMPDIR: $XDG_RUNTIME_DIR

如您所见，snapcraft.yaml 指示系统启动一个名为 electron-launch 的文件。在此示例中，它将信息传递给应用程序的二进制文件：

#!/bin/sh

exec "$@" --executed-from="$(pwd)" --pid=$ > /dev/null 2>&1 &

或者，如果您在严格限制的情况下构建 snap，则可以使用 desktop-launch 命令：

apps:
  myApp:
    # Correct the TMPDIR path for Chromium Framework/Electron to ensure
    # libappindicator has readable resources.
    command: env TMPDIR=$XDG_RUNTIME_DIR PATH=/usr/local/bin:${PATH} ${SNAP}/bin/desktop-launch $SNAP/myApp/desktop
    desktop: usr/share/applications/desktop.desktop