Electron 打包准则 - Arch Linux 中文维基

跳转到内容

# Electron 打包准则

来自 Arch Linux 中文维基
Arch 打包准则

32 位 – 安全 – CLR – CMake – DKMS – Eclipse – Electron – Free Pascal – GNOME – Go – Haskell – Java – 交叉编译工具 – KDE – Lisp – Meson – MinGW – 内核模块 – Node.js – Nonfree – OCaml – Perl – PHP – Python – R – Ruby – Rust – Shell – VCS – Web – Wine – 字体

翻译状态：

- 本文（或部分内容）译自 Electron package guidelines，最近一次同步于 2025-06-29，若英文版本有所更改，则您可以帮助同步与翻译更改的内容。
- 您可以在 ArchWiki 的对应页面找到本文翻译的原始修订历史。
- 本文可能与英文原文存在出入。

本文或本节需要翻译。要贡献翻译，请访问简体中文翻译团队。

附注： 全文需要翻译（在 Talk:Electron 打包准则# 中讨论）

This document covers standards and guidelines on writing PKGBUILDs for Electron.

## Using the system electron

Arch Linux provides versioned electron* packages and an electron包 metapackage for the latest version. They can be used to run an electron application via a shell script wrapper:

    #!/bin/sh

    exec /usr/bin/electron34 /path/to/appname/ "$@"

The `appname/` directory, or alternatively a file bundle called `appname.asar`, can be found in a prebuilt electron application as the `resources/app/` folder (or `resources/app.asar`). Everything else is just a copy of the electron runtime and can be removed from the final package.

注意：Applications that require `ELECTRON_RUN_AS_NODE=1`, e.g. Visual Studio Code, cannot use `/usr/bin/electron*`. See code.sh.

### Editing version on package.json

It is dangerous to edit version of Electron in `package.json` or `package-lock.json` using `sed`. You can use `npm pkg set devDependencies.electron=$(cat /usr/lib/electron*/version)` instead.

本文或本章节的事实准确性存在争议。

原因： Editing package.json may not needed and unrelated to building modules correctly.（在 Talk:Electron 打包准则 中讨论）

### Building compiled extensions against the system electron

Some electron applications have compiled native extensions which link to the electron runtime, and must be built using the correct electron version. Since npm/yarn will always build against a private prebuilt copy of electron, patch the electron dependency from `package.json` to reference the same version as the system electron dependency. The build system will download the prebuilt copy it requires, compile the native extensions, and package everything into a final distribution, but this can be pruned during the `package()` step as usual.

Alternatively, you can remove the electron dependency from `package.json` and set the correct environment variables before running npm:

    export npm_config_target=$(tail /usr/lib/electron/version)
    export npm_config_arch=x64
    export npm_config_target_arch=x64
    export npm_config_disturl=https://electronjs.org/headers[失效链接 2023-10-29 ⓘ]
    export npm_config_runtime=electron
    export npm_config_build_from_source=true
    HOME="$srcdir/.electron-gyp" npm install

Set `HOME` to a path inside the `$srcdir` so the build process does not place any files in your real `HOME` directory. Make sure to adjust the path for all further commands that make use of the `.electron-gyp` cache.

(more details in Electron docs).

### Using electron-builder with system electron

Many projects use electron-builder to build and package the Javascript file and Electron binaries. By default electron-builder downloads the entire electron version that is defined in the package management file (e.g. `package.json`). This might not be desired if you want to use the system electron and save the bandwidth since you are going to throw away the electron binaries anyway. The electron-builder provides the configurations `electronDist` and `electronVersion`, to specify a custom path of Electron and the version the application is packaged for respectively.

Find the electron-builder configuration file (e.g. `electron-builder.json`) and add the following settings:

- `electronDist` to`/usr/lib/electron34` for electron34包
- `electronVersion` to the contents of `/usr/lib/electron34/version` (without the leading `v` if exists)

Packages that apply this: rocketchat-desktopAUR ubports-installer-gitAUR

electron-builder configuration[失效链接 2024-10-12 ⓘ]

Alternatively you can use the CLI to change/add these settings like this:

    ./node_modules/.bin/electron-builder --linux --x64 --dir $dist -c.electronDist=$electronDist -c.electronVersion=$electronVer

Note that you have to specify all these options or it will not work.

本文或本章节的事实准确性存在争议。

原因： Current setting still copies Electron from $electronDist . It is expired to add the method to stop it. （在 Talk:Electron 打包准则 中讨论）

## Architecture

See PKGBUILD#arch.

An Electron package that contains compiled native extensions is architecture-dependent. Otherwise it is most likely architecture-independent.

If the package contains a prebuilt copy of electron, it is always architecture-dependent.

## Directory structure

If the package is architecture-dependent, install the `resources/app/` directory to `/usr/lib/appname/`. Otherwise use `/usr/share/appname/`.

If the package contains a prebuilt copy of electron, copy the final distribution in its entirety to `/opt/appname`.

## Getting version of Electron

Version of Electron could be given by `npm pkg get devDependencies.electron` in the directory containing `package.json` or `package-lock.json`.

Prebuild or Nonfree application hides version of electron from `package.json`, `package-lock.json`, and `version` files. In such case, you may get version by replacing `app` or `app.asar` with `/usr/lib/electron/resources/default_app.asar` and running `pathto/electron-binary --version`.

注意：Avoid doing it at PKGBUILD. This should be last resort to make packages with system-wide electron.
分类：​

- Arch 打包准则
- 包含失效链接的页面

隐藏分类：​

- 使用“模板:Translateme”标记的页面或章节
- 使用“模板:准确性”标记的页面或章节

Electron 打包准则
添加话题