@phylum/webpack-server v1.0.3

Webpack Server Task

Installation

npm i webpack @phylum/webpack @phylum/webpack-server

Usage

The webpack server task runs an express application that serves the webpack output directory. Note, that the webpack task will not be started automatically by the webpack server task.

import { Task } from '@phylum/pipeline';
import { WebpackTask } from '@phylum/webpack';
import { WebpackServerTask } from '@phylum/webpack-server';

const bundle = new WebpackTask(...);

const serveBundle = new WebpackServerTask(webpackTask);

new Task(async t => {
	// Run the webpack compiler:
	await t.use(bundle);
	// Serve bundled files:
	await t.use(serveBundle);
});

Listening

By default, the server will listen on localhost:8080.

new WebpackServerTask(webpackTask, Task.value({
	listen: 8080
}));

You can specify any argument that can be passed to net/server.listen(..)

History fallback

For single page applications, it is common to fallback to /index.html if a request path is not found:

npm i connect-history-api-fallback

import history = require('connect-history-api-fallback');

new WebpackServerTask(webpackTask, Task.value({
	setup({ app }) {
		app.use(history());
	}
}));

Client Updates

When the webpack task completes, an update message is broadcasted to all connected clients via web socket:

{
	"name": "webpack-update",
	// In case of an error:
	"error": "<details>"
	// else:
	"stats": {
		"errors": [...],
		"warnings": [...]
	}
}

Hot module replacement

The hot module replacement client that ships with this package connects to the included web socket server and applies updates or reloads the page if not possible.

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

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

// Optional. If not included, the hmr client
// will fallback to just reloading the web page.
plugins: [
	new webpack.HotModuleReplacementPlugin()
]