Webpack --watch and launching nodemon?

Question

Thanks to an excellent answer by @McMath I now have webpack compiling both my client and my server. I'm now on to trying to make webpack --watch be useful. Ideally I'd like to have it spawn something like nodemon for my server process when that bundle changes, and some flavor of browsersync for when my client changes.

I realize it's a bundler/loader and not really a task runner, but is there some way to accomplish this? A lack of google results seems to indicate I'm trying something new, but this must have been done already..

I can always have webpack package to another directory and use gulp to watch it/copy it/browsersync-ify it, but that seems like a hack.. Is there a better way?

score 68 · Answer 1 · edited Dec 05 '17 at 07:59

68

Install the following dependencies:

npm install npm-run-all webpack nodemon

Configure your package.json file to something as seen below:

`package.json`

{
  ...

  "scripts": {
    "start"        : "npm-run-all --parallel watch:server watch:build",
    "watch:build"  : "webpack --watch",
    "watch:server" : "nodemon \"./dist/index.js\" --watch \"./dist\""
  },

  ...

}

After doing so, you can easily run your project by using npm start.

Don't forget config WatchIgnorePlugin for webpack to ignore ./dist folder.

Dependencies

npm-run-all - A CLI tool to run multiple npm-scripts in parallel or sequential.
webpack - webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset.
nodemon - Simple monitor script for use during development of a node.js app.

edited Dec 05 '17 at 07:59

dsapalo

1,590
15
32

answered Sep 19 '16 at 14:05

Ling

913
1
8
16

10

It works. But a bit buggy. If your folder dist does not exist while first run you can receive an error. – aprisniak Jan 16 '17 at 08:51
Don't forget the '--inspect ' flag. – Remy Jul 24 '19 at 12:20
1

@Ling This does not start two builds for client and server though. – Mukesh Soni Oct 27 '19 at 07:32

score 34 · Accepted Answer · edited Apr 02 '21 at 12:07

34

Faced the same problem and found the next solution - webpack-shell-plugin. It

allows you to run any shell commands before or after webpack builds

So, thats my scripts in package.json:

"scripts": {
      "clean": "rimraf build",
      "prestart": "npm run clean",
      "start": "webpack --config webpack.client.config.js",
      "poststart": "webpack --watch --config webpack.server.config.js",
}

If I run 'start' script it launches next script sequence: clean -> start -> poststart. And there is part of 'webpack.server.config.js':

var WebpackShellPlugin = require('webpack-shell-plugin');

...
if (process.env.NODE_ENV !== 'production') {
    config.plugins.push(new WebpackShellPlugin({onBuildEnd: ['nodemon build/server.js --watch build']}));
}
...

"onBuildEnd" event fires only once after first build, rebuilds are not trigger "onBuildEnd", so nodemon works as intended

edited Apr 02 '21 at 12:07

Marcos Curvello

743
10
22

answered Apr 07 '17 at 08:14

Jonik

954
2
9
20

Can you share the rest of the file `webpack.server.config.js`? – Bob Apr 08 '20 at 11:58
Cause it didn't work when I tried these: ` "start": "cross-env NODE_ENV=development webpack --watch", "poststart": "cross-env NODE_ENV=development webpack --watch --config webpack.server.config.js"` ` var WebpackShellPlugin = require('webpack-shell-plugin') module.exports = { plugins: (process.env.NODE_ENV !== 'production') ? [ new WebpackShellPlugin({ onBuildEnd: [ 'cross-env NODE_ENV=development nodemon server/server.js --watch ./dist' ] }) ] : [] } ` – Bob Apr 08 '20 at 11:59

score 17 · Answer 3 · answered Apr 12 '18 at 05:55

17

I like the simplicity of nodemon-webpack-plugin

webpack.config.js

const NodemonPlugin = require('nodemon-webpack-plugin')

module.exports = {
  plugins: [new NodemonPlugin()]
}

then just run webpack with the watch flag

webpack --watch

answered Apr 12 '18 at 05:55

galki

5,536
3
38
50

ford04 · Answer 4 · 2019-08-02T20:51:30.380

In addition to @Ling's good answer:

If you want to build your project once, before you watch it with nodemon, you can use a webpack compiler hook. The plugin's code triggers nodemon in the done hook once after webpack has finished its compilation (see also this helpful post).

const { spawn } = require("child_process")

function OnFirstBuildDonePlugin() {
  let isInitialBuild = true
  return {
    apply: compiler => {
      compiler.hooks.done.tap("OnFirstBuildDonePlugin", compilation => {
        if (isInitialBuild) {
          isInitialBuild = false
          spawn("nodemon dist/index.js --watch dist", {
            stdio: "inherit",
            shell: true
          })
        }
      })
    }
  }
}

webpack.config.js:

  module.exports = {
    ... 
    plugins: [
      ... 
      OnFirstBuildDonePlugin()
    ]
  })

package.json:

"scripts": {
  "dev"  : "webpack --watch"
},

Hope, it helps.

Monarch Wadia · Answer 5 · 2017-09-26T23:16:50.603

2

There's no need to use plugins here. You could try running multiple nodemon instances like below. Try modifying the following script for your use case, and see if it works for you:

"scripts": {
    "start": "nodemon --ignore './public/' ./bin/www & nodemon --ignore './public/' --exec 'yarn webpack'",
    "webpack": "webpack --config frontend/webpack.config.js"
}

edited Sep 26 '17 at 23:16

answered Sep 26 '17 at 22:48

Monarch Wadia

3,184
2
29
33

score 1 · Answer 6 · edited Jun 05 '17 at 20:32

1

You don't need any plugins to use webpack and nodemon, just use this scripts on your package.json

"scripts": {
  "start": "nodemon --ignore './client/dist' -e js,ejs,html,css --exec 'npm run watch'",
  "watch": "npm run build && node ./server/index.js",
  "build": "rimraf ./client/dist && webpack --bail --progress --profile"
},

edited Jun 05 '17 at 20:32

DavidT

2,101
19
26

answered Apr 18 '17 at 06:48

Antoni Xu

129
2
3

What if I need to buil client and server, and server depends on client files cause it's universal application (build client first, after that build server with 'watch' key and run it)? This way won't work. – Jonik Apr 19 '17 at 13:03

score 0 · Answer 7 · answered Dec 31 '17 at 23:45

@Ling has an answer very close to being correct. But it errors the first time somebody runs watch. You'll need to modify the solution as so to prevent errors.

Run npm install npm-run-all webpack nodemon
Create a file called watch-shim.js in your root. Add the following contents, which will create a dummy file and directory if they're missing.
```
var fs = require('fs');

if (!fs.existsSync('./dist')) {
    fs.mkdir('./dist');
    fs.writeFileSync('./dist/bundle.js', '');
}
```

Setup your scripts as so in package.json. This will only run watch if the watch-shim.js file runs successfully. Thereby preventing Nodemon from crashing due to missing files on the first run.

{
    ...
    "scripts": {
        "start": "npm run watch",
        "watch": "node watch-shim.js && npm-run-all --parallel watch:server watch:build",
        "watch:build": "webpack --progress --colors --watch",
        "watch:server": "nodemon \"./dist/bundle.js\" --watch \"./dist/*\""
    }
    ...
},

score 0 · Answer 8 · answered Mar 03 '20 at 09:56

0

Assuming nodemon server.js touch the server.js file afterEmit:

// webpack.config.js

module.exports = {
  // ...
  plugins: [
    // ...,

    // 
    apply: (compiler) => {
      compiler.hooks.afterEmit.tap('AfterEmitPlugin', (compilation) => {

        require('child_process').execSync('touch server.js') // $ touch server.js
      });
    }
  ]
}

answered Mar 03 '20 at 09:56

abernier

22,855
18
73
103

2

I'm really not sure why this answer was downvoted twice, it worked perfectly fine for me and solved all my issues. What it does is that after webpack output is emitted (aka everything is compiled to disk) it runs the command specified in `execSync` call. What I use it for is to run `yalc push` which updates my local registry of packages. Works like a charm including in watch mode! – Anton Nov 01 '20 at 21:03

score 0 · Answer 9 · answered May 12 '21 at 18:09

I tried most of the solution provided above. I believe the best one is to use nodemon-webpack-plugin .

It is very simple to use i.e. just add const NodemonPlugin = require('nodemon-webpack-plugin') to webpack file with new NodemonPlugin() as your plugin.

Below are the scripts to use it:

"scripts": {
    "watch:webpack-build-dev": "webpack --watch --mode development",
    "clean-db": "rm -rf ./db && mkdir -p ./db",
    "local-dev": "npm run clean-db && npm run watch:webpack-build-dev"
    ...
}

After this you can simply run npm run local-dev.

Adding a module to development is usually not as bad as adding to a production one. And mostly you will be using it for the development anyway.

This also doesn't require any additional package like nodemon or npm-run-all etc.

Also nodemon-webpack-plugin only works in watch mode.

Webpack --watch and launching nodemon?

9 Answers9

`package.json`

Dependencies

Linked