Electron Forge 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
- npm
yarn create electron-app my-app --template=webpack
cd my-app
yarn start
npm init electron-app@latest my-app -- --template=webpack
cd my-app
npm start
该脚本将在 my-app
文件夹中创建一个 Electron 项目,其中包含完整的 JavaScript 打包和预配置的构建流程。
更多信息,请参阅 Forge 文档中的入门指南。
上面的代码片段使用了 Forge 的 Webpack 模板,我们推荐它作为新 Electron 项目的起点。该模板围绕 @electron-forge/plugin-webpack
插件构建,该插件以多种方式将 webpack 与 Electron Forge 集成,包括
- 通过 webpack-dev-server 增强本地开发流程,包括支持渲染器中的 HMR;
- 在应用程序打包前处理 webpack 包的构建逻辑;以及
- 在 webpack 打包过程中增加对原生 Node 模块的支持。
如果您需要 TypeScript 支持,可以考虑使用 Webpack + TypeScript 模板。
导入现有项目
Electron Forge CLI 还包含一个用于现有 Electron 项目的导入命令。
- Yarn
- npm
cd my-app
yarn add --dev @electron-forge/cli
yarn electron-forge import
cd my-app
npm install --save-dev @electron-forge/cli
npm exec --package=@electron-forge/cli -c "electron-forge import"
当您使用 import
命令时,Electron Forge 将添加一些核心依赖项并创建一个新的 forge.config.js
配置文件。如果您有任何现有的构建工具(例如 Electron Packager、Electron Builder 或 Forge 5),它将尝试迁移尽可能多的设置。您的一些现有配置可能需要手动迁移。
有关手动迁移的详细信息,请参阅 Forge 的 导入文档。如果您需要帮助,请加入我们的 Discord 服务器!
为什么要切换到 Forge?
如果您已经有用于打包和发布 Electron 应用程序的工具,采用 Electron Forge 所带来的好处仍然可能超过初始的转换成本。
我们认为使用 Forge 有两大好处
-
Forge 在 Electron 支持新功能后会立即获得应用程序构建的新功能。在这种情况下,您无需自行配置新的工具支持,也无需等待其他包最终实现支持后再进行升级。最近的例子包括 macOS 通用二进制文件 和 ASAR 完整性检查。
-
Forge 的多包架构使其易于理解和扩展。由于 Forge 由许多具有清晰职责的小型包组成,因此更容易跟踪代码流。此外,Forge 的可扩展 API 设计意味着您可以编写自己的附加构建逻辑,并与提供的配置选项分开,以适应高级用例。有关编写自定义 Forge 插件、构建器和发布者的更多详细信息,请参阅文档的 扩展 Electron Forge 部分。
破坏性变更
Forge 6 在测试阶段花费了很长时间,其发布节奏逐渐放缓。然而,我们在 2022 年下半年加快了开发速度,并利用了最近几次发布来推送一些最后的重大更改,以准备 v6.0.0 稳定版的发布。
如果您是 Electron Forge 6 的测试用户,请参阅 v6.0.0 的 GitHub 发布说明,了解最近测试版(>=6.0.0-beta.65
)中进行的重大更改列表。
完整的更改和提交列表可以在仓库的 CHANGELOG.md 中找到。
提交您的反馈!
告诉我们您的需求!Electron Forge 团队一直致力于改进项目,以更好地满足用户的需求。
您可以提交功能请求、发布 问题,或只是告诉我们您的反馈,来帮助我们改进 Electron Forge!您也可以加入我们的 官方 Electron Discord 服务器,其中有一个专门用于 Electron Forge 讨论的频道。
如果您想对 https://electronforge.cn 上的 Forge 文档提供任何反馈,我们有一个 GitBook 实例,它与 electron-forge/electron-forge-docs 仓库同步。