介绍 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
请访问 Why 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 已经过漫长的 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 文档提供任何反馈,我们有一个 GitBook 实例,它已同步到 electron-forge/electron-forge-docs 仓库。