Electron-webpacker NPM

Electron-Webpacker (epack for short)

Electron-Webpacker, or epack for short, is a lightweight build tool for Electron + Webpack projects. A toolkit that helps you setup and run Electron + Webpack projects fast removing all the unnecessary infrastructure you'd do manually.

In a nutshell it does these three things

Initializes the base files and folder structure for an Electron + Webpack project. (see init)
Builds Webpack configuration files for both main and renderer processes.
Runs Electron and webpack-dev-server

These are just highlights, it's a lot more complex under the hood. It uses the CLI to run webpack-cli webpack-dev-server electron electron-builder npm. It will search the environment PATH for an available version of these tools. If not found, it will use npm install to install dependencies necessary to build a project.

Epack is simple stupid. It doesn't require you to add anything at all to your package.json and gets out of the way to help you stay focused on what's important--your project. It runs many of the commands you'd execute yourself such as electron and webpack-dev-server behind the scenes speeding up your development process and saving you time. And it's configurable. (see epack.json)

It's really just a build tool. At any time you can stop using Epack and still have a fully working project.

Getting started

Before using the electron-webpacker or the aliases epacker or epack (all do the same thing) commands you must install Epack.

Install

Epack is on NPM. You can install it using the command below.

npm install electron-webpacker -g

or locally in the current project

npm install electron-webpacker

In order to run Epack when installing locally, you must use the npx command to run packages aren't installed globally npm install [pkg] -g.

npx epack init

This is because NPM installs locally dependencies in ./node_modules/.bin and your shell won't see the binaries here unless it's on the PATH environment.

Documentation

Epack is very lightweight. It's entire purpose is helping speed up the build and run process of Electron + Webpack applications. We all know getting the work done is the best part not getting caught up in the process of setup and scripts.

Adding Webpack to any project especially your Electron app adds a build step to your already existing build process further complicating it a bit. When starting your Electron app you must make sure your code has been compiled by Webpack and is built and ready to run. These are tasks you'd normally do manually. Or clutter up your npm scripts with many commands.

Epack can help with that--saving you time.

It runs the commands for you loading in the Webpack config files in your project--just be sure to tell it where those files reside. (see epack.json).

Epack depends on many different CLI tools. webpack-cli webpack-dev-server electron electron-builder and npm.

If it cannot find any of these tools on the path env it will try to install them--it will not try and install NPM it expects it to be available in environment.

Remember Epack has various aliases such as epacker and epack and the full version electron-webpacker. When this article refers to epack you can use any of the aliases. They all do the same thing.

Folder structure

Epack adheres to the standard Electron/Webpack folder structure. It uses this structure as a default. You can structure your project as you wish. Epack forces no structure. Just be sure to tell it where your Webpack configuration files are using epack.json configuration file (see below)

The standard project structure Epack configures using epack init . is:

  .
  ├─ src
  │   ├─ main
  │   │  ├─ main.js
  │   │  └─ webpack.config.js
  │   └──renderer
  │      ├─ main.js
  │      └─ webpack.config.js
  ├─ dist
  │  ├─ main.js
  │  └─ renderer.js
  └─ epack.json

Add Webpack config settings for the Electron main and renderer process in the webpack.config.js file. Epack will see any settings you add here and pass it on to Webpack.

What are the purposes of the files Epack generates?

src/main/main.js This is Electron's main process. It helps startup Electron creating any BrowserWindow's and setting up the environment.

src/main/webpack.config.js This is the Webpack configuration file for your Electron main process. It specifies how Webpack will build your main process source into a single main.js build file in dist/

src/renderer/main.js This is Electron's renderer process. It's what is displayed in the BrowserWindow Electron opens.

src/main/webpack.config.js This is the Webpack configuration file for your Electron renderer process. It specifies how Webpack will build your renderer process into a single renderer.js build file in dist/

dist Anything here is built by Webpack. Change this location by updating your Webpack config. The configuration is inside the output object {output: {}}

epack.json This is the configuration file that Epack creates to keep track of where your Webpack configuration files are for Electron's main and renderer processes. If you use the default standard directory structure (shown above), Epack will find these automatically. If you don't use the standard structure you will need to tell Epack how your project is configured. When running epack init Epack will use an existing epack.json to initialize your project creating and laying out the directory structure you specify.

When I use init, what is inside the webpack.config.js Epack generates for me?

Nothing, Epack doesn't apply any defaults other than specifying your entry file and context. Anything you add here, will be picked up by Epack and sent to webpack-cli when your main or renderer process is built. What you config in your Webpack config always takes priority over any defaults applied by Epack.

src/main/webpack.config.js

// const path = require('path');

module.exports = {
  /*
   * This is just a webpack.config.js file see documentation for
   * configuration of Webpack.
   *
   * Below is the default options automatically applied when running
   *  `epack build`
   *
   * You can override any of the settings below. Settings defined below takes
   * preceedance. If these defaults aren't disired, simply change them.
   *
   */
  // entry: "./main.js",
  // context: path.resolve(__dirname),
  // target: "electron-main",
  // mode: "development",
  // output: {
  //   filename: "./main.js"
  // }
  node: {
    __dirname: false,
    __filename: false
  }
};

src/renderer/webpack.config.js

// const path = require('path');

module.exports = {
  /*
   * This is just a webpack.config.js file see documentation for
   * configuration of Webpack.
   *
   * Below is the default options automatically applied when running
   *  `epack build`
   *
   * You can override any of the settings below. Settings defined below takes
   * preceedance. If these defaults aren't disired, simply change them.
   *
   */
  // entry: "./main.js",
  // or renderer.js if main.js already exists
  // entry: "./renderer.js",
  // context: path.resolve(__dirname),
  // target: "electron-renderer",
  // mode: "development",
  // output: {
  //   filename: "./renderer.js"
  // }
};

Rest assured Epack is lightweight and can be removed at anytime from your project build process. Get going quickly with Epack and if you decide it's not needed anymore remove it from your process and revert back to scripts.

Init

Every project starts somewhere. Some Electron + Webpack tools require you to use git clone [project] to pull down a boiler plate repo or download a quick start zip or maybe you manually put the files into the right spot. With Epack, no need for all that non-sense, it's easy to get a base project started quick. Epack loads a boiler plate setup into your project to help get you going fast and does the tedious part for you.

Run the init i or initialize command below in a project folder to initialize it as an Epack project.

epack init

epack init ../any-folder

By default, epack init will use the current folder '.' to initialize the project.

Example:

Running the command init:

epack init

Yields the output:

➜  project-folder epack init
info: Created directory src/main
info: Created directory src/renderer
info: Writing Electron main process: main.js @ src/main
info: Writing Electron renderer process: main.js @ src/renderer
info: Writing webpack.config.js files @ src/main src/renderer

Build

The build or b command helps build your Webpack files for Electron's main and renderer process. It will load in the webpack.config.js files (or the files specified in epack.json, see epack.json). Then, it passes your Webpack config to webpack-cli building your source (starting at entry point) into the configured 'dist/' folder. e.g., dist/main.js and dist/renderer.js

epack build

epack build ../any-folder

For example, running in project-folder:

epack build

yields the output,

➜  project epack build
info: Running webpack-cli for main process @ src/main
Hash: ce38e7e68b11fce74a3e
Version: webpack 4.43.0
Time: 51ms
Built at: 05/14/2020 10:35:44 PM
  Asset      Size  Chunks             Chunk Names
main.js  6.15 KiB    null  [emitted]  null
Entrypoint null = main.js
[./main.js] 1.47 KiB {null} [built]
[electron] external "electron" 42 bytes {null} [built]
[path] external "path" 42 bytes {null} [built]
[url] external "url" 42 bytes {null} [built]
info: Running webpack-cli for renderer process @ src/renderer
Hash: d86739d4cd6704a98522
Version: webpack 4.43.0
Time: 42ms
Built at: 05/14/2020 10:35:44 PM
      Asset      Size  Chunks             Chunk Names
renderer.js  3.92 KiB    null  [emitted]  null
Entrypoint null = renderer.js
[./main.js] 73 bytes {null} [built]

Run

The run or r or start command is a charm. This is the one that saves you a lot of time. It uses webpack-dev-server and electron CLI. It will run those CLI tools to pack up your Webpack main and renderer process. Then, it runs webpack-dev-server to startup your Electron renderer process and runs electron [src-folder] to start Electron. Put simply, it just starts your app and loads up the Electron window with your renderer process. It takes advantage of hot-module-reload architecture (HMR) to dynamically reload your renderer.js process while you work in real time.

epack run

epack run ../any-folder/

For example, running command

epack run

Yeilds the following output

➜  project epack run           
info: Running webpack-cli for main process @ src/main
Hash: ce38e7e68b11fce74a3e
Version: webpack 4.43.0
Time: 52ms
Built at: 05/14/2020 10:36:04 PM
  Asset      Size  Chunks             Chunk Names
main.js  6.15 KiB    null  [emitted]  null
Entrypoint null = main.js
[./main.js] 1.47 KiB {null} [built]
[electron] external "electron" 42 bytes {null} [built]
[path] external "path" 42 bytes {null} [built]
[url] external "url" 42 bytes {null} [built]
info: Running webpack-dev-server for renderer process @ src/renderer
info: Using port 9000
info: /Users/kingajax/Documents/apps/test/node_modules/.bin/webpack-dev-server
info: Running webpack-dev-server for renderer process @ src/renderer
(electron) The default value of app.allowRendererProcessReuse is deprecated, it is currently "false".  It will change to be "true" in Electron 9.  For more information please check https://github.com/electron/electron/issues/18397
Loading URL @ http://localhost:9000/renderer for environment=development
GVA encoder info: AMD performance mode : 2
ℹ ｢wds｣: Project is running at http://localhost:9000/
ℹ ｢wds｣: webpack output is served from /
ℹ ｢wds｣: Content not from webpack is served from /Users/kingajax/Documents/apps/test/dist
GVA encoder info: deleteSCDMetalContext : texture cache hits: 0, misses: 0
ℹ ｢wdm｣: Hash: e49d1e67069e3886259c
Version: webpack 4.43.0
Time: 265ms
Built at: 05/14/2020 10:36:06 PM
      Asset     Size  Chunks             Chunk Names
renderer.js  300 KiB    null  [emitted]  null
Entrypoint null = renderer.js
[0] multi (webpack)-dev-server/client?http://localhost:9000 ./main.js 40 bytes {null} [built]
[../../node_modules/ansi-html/index.js] /Users/kingajax/Documents/apps/test/node_modules/ansi-html/index.js 4.16 KiB {null} [built]
[../../node_modules/html-entities/lib/index.js] /Users/kingajax/Documents/apps/test/node_modules/html-entities/lib/index.js 449 bytes {null} [built]
[../../node_modules/loglevel/lib/loglevel.js] /Users/kingajax/Documents/apps/test/node_modules/loglevel/lib/loglevel.js 8.41 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/clients/SockJSClient.js] (webpack)-dev-server/client/clients/SockJSClient.js 4.06 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/index.js?http://localhost:9000] (webpack)-dev-server/client?http://localhost:9000 4.29 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/overlay.js] (webpack)-dev-server/client/overlay.js 3.51 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/socket.js] (webpack)-dev-server/client/socket.js 1.53 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/utils/createSocketUrl.js] (webpack)-dev-server/client/utils/createSocketUrl.js 2.91 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/utils/log.js] (webpack)-dev-server/client/utils/log.js 964 bytes {null} [built]
[../../node_modules/webpack-dev-server/client/utils/reloadApp.js] (webpack)-dev-server/client/utils/reloadApp.js 1.59 KiB {null} [built]
[../../node_modules/webpack-dev-server/client/utils/sendMessage.js] (webpack)-dev-server/client/utils/sendMessage.js 402 bytes {null} [built]
[../../node_modules/webpack-dev-server/node_modules/strip-ansi/index.js] (webpack)-dev-server/node_modules/strip-ansi/index.js 161 bytes {null} [built]
[../../node_modules/webpack/hot sync ^\.\/log$] (webpack)/hot sync nonrecursive ^\.\/log$ 170 bytes {null} [built]
[./main.js] 73 bytes {null} [built]

Distribute

The dist or distribute or d commands help you package up your application when you're ready to build for a targeted platform. It uses electron-builder behind the scenes. Make sure you have a proper package.json file and follow the Documentation required for Electron-builder.

It will use webpack-cli to load your Webpack configuration files and build them in production mode.

epack dist

epack dist ../any-folder

MISC

Add --verbose to any command to add additional logging. Useful for tracking down issues with Epack before posting an issue or asking for help.

epack init --verbose

You can run --version to get the version or --help if you're unsure about the commands to run.

epack.json (configuration)

Epack uses a configuration file to find what it needs to run, build, and distribute your project properly. If it can't find it, it will use the defaults built into it and write the file to the current folder. You can change the settings in this file at anytime. If you use the standard Epack folder structure, you won't need the epack.json file and can delete it.

{
  "main": {
    "path": "src/main",
    "webpack-file": "webpack.config.js"
  },
  "renderer": {
    "path": "src/renderer",
    "webpack-file": "webpack.config.js"
  }
}

main

path The path where your Webpack config file exists for the Electron main process. The default value is src/main

webpack-file The name of the Webpack config file to load for the Electron main. The default value is webpack.config.js

renderer

path The path where your Webpack config file exists for the Electron renderer process. The default value is src/renderer

webpack-file The name of the Webpack config file to load for the Electron renderer. The default value is webpack.config.js

If Epack can't find these files, it can't do it's work proerly. At a bare minimum, you must configure these paths properly. It will try to use the defaults if no epack.json file exists in the current project.

Support

General

If you have any problems with epack be sure to create an issue. Remember you can run Epack in debug mode by adding --verbose to any command. This should provide more information about what's going on. You will get a lot of information dumped back at you.

Most Epack related issues deal with Epack not finding the dependencies (CLI tools) it relies on to do most of the work. This means the various CLI tools it runs. Make sure these are installed and available on the path environment.

Happy Electron + Webpack dev.

How to configure Webpack?

Epack is simple stupid. It's main purpose is to be lightweight and run fast. It's only job is running the tools you need to get the job done. This is many of the already existing cli tools such as electron webpack-cli webpack-dev-server. It passes your Webpack config files onto these tools.

You configure Webpack as you would any other Webpack project. Your Webpack-file, usually referered to as webpack.config.js, can be configured with every configuration option available. Refer to the Webpack configuration documentation for more information on how to configure Webpack.

For example,

If you'd like to change the Webpack entry file for your Electron main process open src/main/webpack.config (if you're following the standard folder structure, otherwise open your webpack file for your Electron main process).

Add the setting below to your Webpack file to modify the entry point.

module.exports = {
  /*
   * This is just a webpack.config.js file see documentation for
   * configuration of Webpack.
   *
   * Below is the default options automatically applied when running
   *  `epack build`
   *
   * You can override any of the settings below. Settings defined below takes
   * preceedance. If these defaults aren't disired, simply change them.
   *
   */
  entry: "./main.js",
  // context: path.resolve(__dirname),
  // target: "electron-main",
  // mode: "development",
  // output: {
  //   filename: "./main.js"
  // },
  // node: {
  //   __dirname: false,
  //   __filename: false
  // }
};

How does Electron talk to Webpack-Dev-Server?

In the boilerplate code generated by epack init, you'll see main.js inside src/main.

Inside this file, your electron main process (main.js) reads the environment variable determining if it's running in "development" or "production". If it's running in development, it swaps out the loadURL(url) with the URL that webpack-dev-server is listening on hosting your renderer process.

Inside your Electron main process code you will find the following lines:

// Create the browser window.
const win = new BrowserWindow({
  width: 800,
  height: 600,
  webPreferences: {
   nodeIntegration: true
  }
});

Above just creates a BrowserWindow in Electron setting the width and height.

import {format} from "url";

/*
 * Build the URL that is loaded when Node's NODE_ENV is `production`
 */
var prodUrl = format({

  /*
   * pathname builds the base path to your static files
   * which will be loaded in production.
   */
  pathname: path.join(__dirname, "index.html"),

  /*
   * we're loading this file locally, not on
   * some server hosted somewhere else.
   */
  protocol: 'file',
  slashes: true
});

Above, we build the path for Electron "production". We won't have webpack-dev-server serving our renderer process in production. We will need to load the minified all packed up version of our application (static gen files).

/*
 * Did EPACK send us the `webpack-dev-server` port as a NODE_ENV variable?
 */
var port = process.env.WEBPACK_DEV_SERVER_PORT || 9000;

/*
 * When the NODE_ENV is `development`, use the `webpack-dev-server`
 * URL. It's hosting our content for us and using HMR and reloads.
 */
var url = process.env.NODE_ENV == "development"  ?
`http://localhost:${port}/${process.env.WEBPACK_DEV_SERVER_PATH || "renderer"}` : prodUrl;

// In Electron's main process, output what URL was loaded.
console.log(`Loading URL @ ${url} for environment=${process.env.NODE_ENV}`);

/*
 * Based on our NODE_ENV, whether we're currently in `production` or
 * `development`, load the correct URL. In `development`, our renderer
 * process is served from `webpack-dev-server`, however, in production, mostly
 * after we've packaged up our application for distribution, `webpack-dev-server`
 * won't be there, so we'll need to use a relative local path.
 */
win.loadURL(url);

Above, we try and read the webpack-dev-server port provided as an ENV variable. If not provided, we fall back to using port 9000. You can see when Electron is running in "development" it loads the webpack-dev-server localhost url running on port 9000 (or configured port). Otherwise, it uses the production URL. For Webpack and Electron to work together and make development easier, if you're using webpack-dev-server during development, you'll want to be sure the http://localhost:9000/renderer URL is loaded properly pointing to webpack-dev-server or you will see a blank page when electron loads the window.

Help my Electron window is blank?

Open your Electron main process (src/main/main.js), be sure to check the URL that is loading into the window win.loadURL(url). If Electron can't load this URL, you will see a blank screen. Don't forget that Webpack-dev-server is running behind the scenes in "development" mode serving your renderer process in real time with hot-module-reload (HMR). If you're running in "production" mode webpack-dev-server isn't running. Instead your src/renderer/main.js process has been bundled up and put in your 'dist' folder. Be sure your dist/ folder contains all the necessary files such as index.html that Electron will try to load. There is also another setting you must enable in webpack.config.js called node: {__dirname: false} in order for your Electron main process to resolve URLs properly in production when win.loadURL(url) is called. These are standard Webpack config issues so be sure to read the Webpack configuration documentation page.