开始

使用完整的构建管道快速搭建 Electron 项目

概述

Electron Forge 是一个用于打包和分发 Electron 应用程序的一体化工具。它结合了许多单一用途的包，以创建一个开箱即用的完整构建管道，包括代码签名、安装程序和构件发布。对于高级工作流，可以通过其插件 API 在 Forge 生命周期中添加自定义构建逻辑。自定义构建和存储目标可以通过创建自己的 Maker 和 Publisher 来处理。

创建新应用程序

要开始使用 Electron Forge，我们首先需要用create-electron-app。此脚本是 Forge 的 Init 命令的便捷包装器。

提示

Electron Forge 目前仅支持 npm 和 Yarn Classic。如果您使用的是 Yarn >=2，请使用nodeLinker: node-modules安装模式。

npm init electron-app@latest my-app

使用模板

Forge 的初始化脚本可以添加带有--template=[template-name]该标志的附加模板代码。

npm init electron-app@latest my-app -- --template=webpack

目前有四个第一方模板：

• webpack
• webpack-typescript
• vite
• vite-typescript

所有这些模板都是围绕插件构建的，这些插件将 JavaScript 代码捆绑起来用于生产，并包括一个开发服务器，以提供更好的开发人员体验。

TIP

我们强烈建议在初始化应用程序时使用这些模板，以利用现代前端 JavaScript 工具。

要了解有关为 Electron Forge 编写自己的模板的更多信息，请查看编写模板指南！

启动应用

您现在应该有一个名为my-app的目录，其中包含基本 Electron 应用程序所需的所有文件

cd my-app
npm start

构建可分发对象

因此，您有一个很棒的应用程序，您希望将其全部打包并与全世界分享。如果您运行make该脚本，Electron Forge 将为您生成特定于平台的可分发对象，供您与所有人共享。有关您可以创建哪种可分发对象的更多信息，请查看 Makers 文档。

npm run make

发布应用

现在，您拥有可与用户共享的可分发对象。如果您运行publish该脚本，Electron Forge 将使用您选择的发布方法为您发布特定于平台的可分发对象。例如，如果要将资产发布到 GitHub，可以使用以下方法安装 GitHub 发布者依赖项。

npm install --save-dev @electron-forge/publisher-github

根据文档配置发布者后，运行以下命令以上传您的可分发对象：

npm run publish

有关我们目前支持的发布者的更多信息，请查看发布者文档。

高级用法

启动、构建和发布基本应用程序后，就可以添加自定义配置了，这可以在文件forge.config.js中完成。配置选项在 Configuration Docs 中指定。

您还可以查看有关我们一些更高级功能的文档，例如：

• 添加插件
• 调试应用
• 编写您自己的制作者、发布者和插件