Local Electron

This plugin should only be used by people who are building Electron locally themselves, if you want to use a fork of Electron check out the environment variables you can use to configure electron-download.
This plugin allows you to both run and package/make your app using a local build of Electron, this is incredibly useful if you want to test a feature or a bugfix in your app before making a PR up to the Electron repository.  If you want to set up a local build of Electron you should check out the build instructions for your platform (Windows, macOS or Linux).
Usage
forge.config.js
1
{
2
  plugins: [
3
    ['@electron-forge/plugin-local-electron', {
4
      electronPath: '/Users/me/projects/electron/out/D'
5
    }]
6
  ]
7
}
Copied!
Configuration
All possible configuration options are documented in LocalElectronPluginConfig.  Please note that all paths must be absolute, you should use path.resolve() to make things deterministic.

Auto Unpack Native Modules

Electron Compile

Last modified 3yr ago

Copy link

Edit on GitHub

Contents

Usage

Configuration