npmpackage.info

webpack-isomorphic-dev-middleware

The webpack-dev-middleware, but for isomorphic applications

4.1.0

MIT

JavaScript

Installations

npm install webpack-isomorphic-dev-middleware

Pull Requests

Open

5

Total

59

Closed

28

Merged

26

Issues

Open

7

Total

30

Closed

23

Releases

Unable to fetch releases

Developer

moxystudio

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

10.7.0

NPM Version

6.1.0 Statistics

39 Stars

161 Commits

6 Forks

11 Watching

6 Branches

5 Contributors

Updated on 16 Feb 2023

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

388,522

Last day

-49.2%

Compared to previous day

Last week

209

Compared to previous week

Last month

-7.1%

809

Compared to previous month

Last year

-0.7%

22,846

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

webpack-isomorphic-dev-middleware

The webpack-dev-middleware, but for isomorphic applications.

Showcase

Installation

$ npm install webpack-isomorphic-dev-middleware --save-dev

The current version works with webpack v2, v3 and v4.
You might get a peer dependency warning when using webpack v2 or v3 but you may ignore it.

Motivation

Building applications powered by webpack with server-side rendering (isomorphic/universal apps) is hard.

When making a production build, you must compile both the client and server. When developing, we want to rebuild the client & server and bring in the new compiled code without restarting/reloading the application. This is complex, especially setting up the development server.

To make your development workflow easier to setup, webpack-isomorphic-dev-middleware offers an express middleware that:

Looks for code changes in both the client and the server and automatically compiles them
Optimizes compilation by using in-memory filesystem
Delays responses until the aggregated compiler finishes
Adds isomorphic to res.locals, which includes the webpack stats and the methods exported in your server file
Offers beautiful compilation reporting into your terminal
Receive status through OS notifications
Shows compilation errors in the browser on refresh, similar to the ones you get on the terminal

Usage

1const express = require('express');
2const webpack = require('webpack');
3const webpackIsomorphicDevMiddleware = require('webpack-isomorphic-dev-middleware');
4const webpackHotMiddleware = require('webpack-hot-middleware');
5
6const clientCompiler = webpack({ /* webpack client config */ });
7const serverCompiler = webpack({ /* webpack server config */ });
8const app = express();
9
10// Serve any static files from the public folder
11app.use('/', express.static('public', { maxAge: 0, etag: false }));
12// Add the middleware that will wait for both client and server compilations to be ready
13app.use(webpackIsomorphicDevMiddleware(clientCompiler, serverCompiler));
14// You may also add webpack-hot-middleware to provide hot module replacement to the client
15app.use(webpackHotMiddleware(clientCompiler, { quiet: true }));
16
17// Catch all route to attempt to render our isomorphic app
18app.get('*', (req, res, next) => {
19    // res.isomorphic contains `compilation` & `exports` properties:
20    // - `compilation` contains the webpack-isomorphic-compiler compilation result
21    // - `exports` contains the server exports, usually one or more render functions
22    const { render } = res.locals.isomorphic.exports;
23
24    render({ req, res })
25    .catch((err) => setImmediate(() => next(err)));
26});

The middleware function is flexible and supports various signatures:

Two separate webpack compilers

1const clientCompiler = webpack({ /* webpack client config */ });
2const serverCompiler = webpack({ /* webpack server config */ });
3
4app.use(webpackIsomorphicDevMiddleware(clientCompiler, serverCompiler, { /* options */ }));

A webpack multi-compiler where the first and second indexes belong to the client and server respectively, see https://webpack.js.org/api/node

1const compiler = webpack([
2    /* webpack client config */,
3    /* webpack server config */,
4]);
5
6app.use(webpackIsomorphicDevMiddleware(compiler, { /* options */ }));

A webpack-isomorphic-compiler that simplifies compiling isomorphic apps

1const isomorphicCompiler = webpackIsomorphicCompiler(
2    /* webpack client config */,
3    /* webpack server config */
4);
5
6app.use(webpackIsomorphicDevMiddleware(isomorphicCompiler, { /* options */ }));

Available options:

Name	Description	Type	Default
memoryFs	Either disable or enable in-memory filesystem (disabling decreases performance)	boolean	true
watchOptions	Options to pass to webpack's watch	object
watchDelay	Delay calling webpack's watch for the given milliseconds	number	0
report	Enables reporting	boolean/object	`{ stats: 'once' }`
notify	Report build status through OS notifications	boolean/object	false
headers	Headers to be sent when serving compiled files	object	`{ 'Cache-Control': 'max-age=0, must-revalidate' }`
findServerAssetName	Finds the server asset to require from the Webpack stats	function	first js asset from the first entrypoint

By default, findServerAsset selects the first JavaScript asset from first entrypoint. If that doesn't suit your Webpack configuration, you may change it:

1{
2    // Finds the asset with the `server` word in its name
3    findServerAssetName: (stats) => stats.assets
4        .map((asset) => asset.name)
5        .find((name) => /\bserver\b.+\.js$/.test(name));
6}

Tests

$ npm test
$ npm test -- --watch during development

License

MIT License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

93 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-h452-7996-h45h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-p28h-cc7q-c4fg
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-779f-wgxg-qr8f
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to webpack-isomorphic-dev-middleware

webpack-dev-middleware

7.4.2

A development middleware for webpack

webpack-hot-middleware

2.26.1

Webpack hot reloading you can attach to your own server

webpack-dev-server

5.1.0

Serves a webpack app. Updates the browser on changes.

@gatsbyjs/webpack-hot-middleware

2.25.3

Webpack hot reloading you can attach to your own server

webpack-isomorphic-dev-middleware

Installations

Pull Requests

5

59

28

26

Issues

7

30

23

Releases

Unable to fetch releases

Developer

moxystudio

Developer Guide

CommonJS

No

10.7.0

6.1.0

Statistics

Languages

Total Downloads

388,522

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

webpack-isomorphic-dev-middleware

Installation

Motivation

Usage

Tests

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to webpack-isomorphic-dev-middleware