@phylum/webpack-electron v1.0.0-beta.2

Webpack Electron Task

This package exposes a task that runs an electron instance for webpack bundled code and supports hot module replacement in the main and render process.

Installation

npm i webpack @phylum/webpack electron @phylum/webpack-electron

Usage

The webpack electron task runs an electron main process from bundled sources. Note, that the webpack tasks will not be started automatically by the webpack electron task.

import { Task } from '@phylum/pipeline';
import { WebpackTask } from '@phylum/webpack';
import { WebpackElectronTask } from '@phylum/webpack-electron';

const bundleMain = new WebpackTask(...);

const electron = new WebpackElectronTask(Task.value({
	main: bundleMain
}));

new Task(async t => {
	// Run the webpack compiler:
	await t.use(bundleMain);
	// Start an electron process:
	await t.use(electron);
});

Note that the electron task assumes, that the main bundle has already been compiled.

Hot Module Replacement

Main Bundle

new WebpackElectronTask(Task.value({
	// Enable hot module replacement:
	mainHmr: true,
	main: bundleMain
}));

// Import the hmr client somewhere in your main process code...
import '@phylum/webpack-electron/dist/hmr';

// ...or add it to your entry point:
entry: ['@phylum/webpack-electron/dist/hmr', './src/main.js'],

// Optional. Include the hmr runtime:
plugins: [
	new webpack.HotModuleReplacementPlugin()
]

If the hmr runtime is not included or an update is rejected, the main process will be rebooted.

Renderer Bundles

For renderer hmr support, it is required that the hmr client is also included in the main bundle as it routes update signals to one or more renderer processes.

new WebpackElectronTask(Task.value({
	...

	// Enable renderer hmr:
	rendererHmr: true

	// single renderer bundle:
	renderer: bundleRenderer,

	// multiple renderer bundles:
	renderer: {
		foo: bundleRendererFoo,
		bar: bundleRendererBar
	}
}));

// Import the hmr client somewhere in your code...
import '@phylum/webpack-electron/dist/hmr';

// and specify the name when using multiple renderer bundles:
import '@phylum/webpack-electron/dist/hmr?name=foo';

// ...or add it to your entry point:
entry: ['@phylum/webpack-electron/dist/hmr?...', './src/renderer.js'],

// Optional. Include the hmr runtime:
plugins: [
	new webpack.HotModuleReplacementPlugin()
]

When a renderer process rejects an update or the hmr runtime is not included, the renderer page will be reloaded by default. This behaviour can be changed to rebooting the main process instead by using the onreject query parameter:

import '@phylum/webpack-electron/dist/hmr?onreject=reboot';

Sample

The code in the /sample directory shows how a basic project could look like.

• Webpack is used for bundling main and renderer process code.
• Both code bases are watched for changes.

# Clone the repository:
git clone https://github.com/phylumjs/webpack-electron.git

# Install dependencies
npm install

# Compile webpack-electron:
# (This is needed because the sample uses this package directly)
npm run compile

# Run the sample in dev mode:
npx phylum ./sample -d

# Build the sample for production:
npx phylum ./sample

Troubleshooting

The main process can not be started

• The electron uses a file named index.js from your main bundles's output directory by default.
• Make sure, that the webpack option output.filename does not contain placeholders like '[name]' or 'hash'.
• Startup can be customized using entry, cwd and args options.

Hot module replacement always reboots the main process or reloads the renderer page

• Make sure the HotModuleReplacementPlugin is included in your webpack config.
• Make sure that the hmr client is not a webpack external.