Squirrel.Windows

使用 Electron Forge 為您的 Electron 應用程式建立 Windows 安裝程式。

Squirrel.Windows 目標使用 Squirrel.Windows 框架建置您的應用程式。它會產生三個檔案

檔案	描述
{appName} Setup.exe	您的應用程式的主要可執行安裝程式
{appName}-full.nupkg	用於更新的 NuGet 套件檔案
RELEASES	用於檢查是否有可用更新的中繼資料檔案

Squirrel.Windows 是一種無需提示、無需麻煩、無需管理員權限即可安裝 Windows 應用程式的方法，因此是最使用者友善的方法。

需求

您只能在 Windows 機器上，或是在安裝了 mono 和 wine 的 Linux 機器上建置 Squirrel.Windows 目標。

安裝

npm install --save-dev @electron-forge/maker-squirrel

用法

將此模組新增至您的 建構器 區段，位於您的 Forge 設定中

forge.config.js

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        certificateFile: './cert.pfx',
        certificatePassword: process.env.CERTIFICATE_PASSWORD
      }
    }
  ]
};

Squirrel.Windows 建構器繼承了 electron-winstaller 模組的所有設定選項，除了 建構器設定的 appDirectory 和 outputDirectory 之外。

完整的設定選項記錄在 MakerSquirrelConfig 類型中。

必要的中繼資料

Squirrel.Windows 需要必要的套件中繼資料才能滿足 .nuspec 清單格式。在 Electron Forge 中有兩種方法可以指定此資訊。

在 package.json 中

預設情況下，Squirrel.Windows 建構器會擷取專案 package.json 檔案中的 author 和 description 欄位。

package.json

{
  // ...
  "author": "Alice and Bob",
  "description": "An example Electron app"
  // ...
}

在您的 Forge 設定中

或者，您也可以直接在您的 Squirrel.Windows 建構器設定中覆寫這些值。

forge.config.js

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        authors: 'Alice and Bob',
        description: 'An example Electron app'
      }
    }
  ]
};

請注意，Forge 設定欄位是 "authors"，而 package.json 欄位則稱為 "author"。

處理啟動事件

當您第一次執行應用程式、更新它和解除安裝它時，Squirrel.Windows 會額外產生您的應用程式並帶有一些特殊引數。您可以在 electron-winstaller README 中閱讀有關這些引數的更多資訊。

處理這些引數並在這些事件期間停止您的應用程式多次啟動的最簡單方法是使用 electron-squirrel-startup 模組作為您的應用程式執行的第一件事。

main.js

const { app } = require('electron');

// run this as early in the main process as possible
if (require('electron-squirrel-startup')) app.quit();

除錯

若要取得此建構器的高階偵錯記錄，請新增 DEBUG=electron-windows-installer* 環境變數。