https://github.com/Izhaki/nodemon-webpack-plugin

A webpack plugin that uses Nodemon to start and reload the server.
https://github.com/Izhaki/nodemon-webpack-plugin

node nodemon server webpack-plugin

Last synced: about 1 month ago
JSON representation

A webpack plugin that uses Nodemon to start and reload the server.

• Host: GitHub
• URL: https://github.com/Izhaki/nodemon-webpack-plugin
• Owner: Izhaki
• License: mit
• Created: 2017-07-20T00:21:23.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T09:38:35.000Z (3 months ago)
• Last Synced: 2024-07-19T08:15:20.590Z (about 2 months ago)
• Topics: node, nodemon, server, webpack-plugin
• Language: JavaScript
• Homepage:
• Size: 2.1 MB
• Stars: 182
• Watchers: 4
• Forks: 21
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nodemon Webpack Plugin



  





  

    

  

  

    

  

  

    

  



Uses [Nodemon](https://nodemon.io/) to watch and restart your module's output file (presumably a server), but only when webpack is in watch mode (ie, `--watch`).

Saves the need for installing, configuring and running Nodemon as a separate process.

## Installation

```bash

npm install nodemon-webpack-plugin --save-dev

```

## Usage

```javascript

const NodemonPlugin = require('nodemon-webpack-plugin'); // Ding

module.exports = {

  entry: './src/server.js',

  output: {

    path: path.resolve('./dist'),

    filename: 'server.js',

  },

  plugins: [

    new NodemonPlugin(), // Dong

  ],

};

```

Then:

```shell

$ webpack --watch

```

## Modes

### Zero-config mode

```javascript

new NodemonPlugin();

```

Will watch and restart the output file.

### With config

Provide a [Nodemon config object](https://github.com/remy/nodemon#config-files), like so:

```javascript

new NodemonPlugin({

  // If using more than one entry, you can specify

  // which output file will be restarted.

  script: './dist/server.js',

  // What to watch.

  watch: path.resolve('./dist'),

  // Arguments to pass to the script being watched.

  args: ['demo'],

  // Node arguments.

  nodeArgs: ['--debug=9222'],

  // Files to ignore.

  ignore: ['*.js.map'],

  // Extensions to watch.

  ext: 'js,njk,json',

  // Unlike the cli option, delay here is in milliseconds (also note that it's a string).

  // Here's 1 second delay:

  delay: '1000',

  // Detailed log.

  verbose: true,

  // Environment variables to pass to the script to be restarted

  env: {

    NODE_ENV: 'development',

  },

});

```

For a full list of options, see Nodemon's [type definitions](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/nodemon/index.d.ts) (`Settings` interface).