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 插件、maker 和发布者的更多详细信息,请参阅文档的 扩展 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://forge.electron.js.cn 上的 Forge 文档提供任何反馈,我们有一个 GitBook 实例同步到 electron-forge/electron-forge-docs 仓库。