跳转到主要内容

Electron Forge 6 介绍

·6 分钟阅读

我们很高兴地宣布 Electron Forge v6.0.0 现已发布!这是 Forge 自 2018 年以来的第一个主要版本,并将项目从 electron-userland 迁移到 Github 上的主要 electron 组织。

请继续阅读,了解有哪些新功能以及您的应用程序如何采用 Electron Forge!

什么是 Electron Forge?

Electron Forge 是一款用于打包和分发 Electron 应用程序的工具。它将 Electron 的构建工具生态系统统一到一个可扩展的接口中,这样任何人都可以直接开始制作 Electron 应用程序。

主要功能包括

  • 📦 应用程序打包和代码签名
  • 🚚 在 Windows、macOS 和 Linux 上的可定制安装程序(DMG、deb、MSI、PKG、AppX 等)
  • ☁️ 针对云提供商(GitHub、S3、Bitbucket 等)的自动化发布流程
  • ⚡️ 易于使用的 webpack 和 TypeScript 模板
  • ⚙️ 支持原生 Node.js 模块
  • 🔌 可扩展的 JavaScript 插件 API
延伸阅读

访问 为什么选择 Electron Forge 说明文档,了解更多关于 Forge 的理念和架构。

v6 有哪些新功能?

完全重写

从 v1 到 v5,Electron Forge 都是基于现已停止维护的 electron-compile 项目。Forge 6 是对该项目的完全重写,采用了一个新的模块化架构,可以扩展以满足任何 Electron 应用程序的需求。

在过去几年中,Forge v6.0.0-beta 已经实现了与 v5 的功能对等,并且代码变动已大幅减缓,使得该工具已准备好被广泛采用。

不要安装错误的包

对于版本 5 及以下,Electron Forge 发布在 npm 上的 electron-forge 包中。从 v6 重写开始,Forge 被构造成一个包含许多小型项目的 monorepo 项目。

官方支持

历史上,Electron 的维护者对构建工具一直持不干涉态度,将这项任务留给了各种社区包。然而,随着 Electron 作为一个项目日趋成熟,新的 Electron 开发者越来越难理解他们需要哪些工具来构建和分发他们的应用程序。

为了帮助 Electron 开发者在分发过程中得到指导,我们决定将 Forge 作为 Electron 官方的、功能完备的构建流程

在过去的一年里,我们一直在逐步将 Forge 集成到官方的 Electron 文档中,并且最近将 Forge 从其旧的 electron-userland/electron-forge 迁移到了 electron/forge 仓库。现在,我们终于准备好向广大用户发布 Electron Forge!

入门

初始化一个新的 Forge 项目

可以使用 create-electron-app CLI 脚本来搭建一个新的 Electron Forge 项目。

yarn create electron-app my-app --template=webpack
cd my-app
yarn start

该脚本将在 my-app 文件夹中创建一个 Electron 项目,其中包含完整的 JavaScript 打包和预配置的构建流程。

更多信息,请参阅 Forge 文档中的入门指南

一流的 webpack 支持

以上代码片段使用了 Forge 的 Webpack 模板,我们推荐将其作为新 Electron 项目的起点。该模板基于 @electron-forge/plugin-webpack 插件构建,该插件以多种方式将 webpack 与 Electron Forge 集成,包括:

  • 通过 webpack-dev-server 增强本地开发流程,包括支持渲染器中的 HMR;
  • 在应用程序打包前处理 webpack 包的构建逻辑;以及
  • 在 webpack 打包过程中增加对原生 Node 模块的支持。

如果您需要 TypeScript 支持,可以考虑使用 Webpack + TypeScript 模板

导入现有项目

Electron Forge CLI 还包含一个用于现有 Electron 项目的导入命令。

cd my-app
yarn add --dev @electron-forge/cli
yarn electron-forge import

当您使用 import 命令时,Electron Forge 会添加一些核心依赖项并创建一个新的 forge.config.js 配置文件。如果您有任何现有的构建工具(例如 Electron Packager、Electron Builder 或 Forge 5),它会尝试迁移尽可能多的设置。您的一些现有配置可能需要手动迁移。

手动迁移的详细信息可以在 Forge 的导入文档中找到。如果您需要帮助,请访问我们的 Discord 服务器

为什么要切换到 Forge?

如果您已经有用于打包和发布 Electron 应用程序的工具,采用 Electron Forge 所带来的好处仍然可能超过初始的转换成本。

我们认为使用 Forge 有两大好处

  1. 一旦 Electron 支持新的应用程序构建功能,Forge 就会立即获得这些新功能。在这种情况下,您将不需要自己集成新的工具支持,或者等待其他包最终实现该支持后再进行升级。近期的例子包括 macOS 通用二进制文件ASAR 完整性检查

  2. Forge 的多包架构使其易于理解和扩展。由于 Forge 由许多职责明确的小包组成,因此更容易跟踪代码流程。此外,Forge 的可扩展 API 设计意味着您可以编写自己的额外构建逻辑,独立于所提供的配置选项,以适应高级用例。有关编写自定义 Forge 插件、maker 和 publisher 的更多详细信息,请参阅文档的扩展 Electron Forge 部分。

破坏性变更

Forge 6 已经经历了很长的 beta 阶段,其发布节奏已逐渐放缓。然而,我们在 2022 年下半年加快了开发速度,并利用最后几个版本在 v6.0.0 稳定版发布前推送了一些最终的破坏性更改。

如果您是 Electron Forge 6 beta 用户,请参阅 v6.0.0 GitHub 发布说明,了解近期 beta 版本(>=6.0.0-beta.65)中进行的破坏性更改列表。

完整的更改和提交列表可以在仓库的 CHANGELOG.md 中找到。

提交您的反馈!

告诉我们您的需求!Electron Forge 团队一直致力于改进项目,以更好地满足用户的需求。

您可以通过提交功能请求、发布问题或仅仅告诉我们您的反馈来帮助我们改进 Electron Forge!您也可以加入我们的官方 Electron Discord 服务器,那里有一个专门用于讨论 Electron Forge 的频道。

如果您想对 https://electronforge.cn 上的 Forge 文档提供任何反馈,我们有一个与 electron-forge/electron-forge-docs 仓库同步的 GitBook 实例。