入门

快速搭建一个拥有完整构建管道的 Electron 项目

概述

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

创建新应用

要开始使用 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 代码捆绑到生产环境中，并包含一个开发服务器以提供更好的开发体验。

我们强烈建议在初始化您的应用程序时使用这些模板，以利用现代前端 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

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

高级用法

一旦你拥有一个基本的应用程序开始启动、构建和发布，就该添加自定义配置了，这可以在forge.config.js 文件中完成。配置选项在Configuration Docs 中指定。

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

下一步导入现有项目

上次更新