@datorama/open-browser-webpack-plugin

Opens the browser when Webpack is ready serving your files.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
11923Nov 2, 2019Sep 11, 2015Minified + gzip package size for @datorama/open-browser-webpack-plugin in KB

Readme

Open Browser Webpack Plugin

Opens a new browser tab when Webpack loads. Very useful if you're lazy and don't want to force yourself to open a new tab when Webpack is ready to play!

Installation

npm install open-browser-webpack-plugin --save-dev

Usage

Simply require the plugin and add it in the plugins section:

var OpenBrowserPlugin = require('open-browser-webpack-plugin');

module.exports = {
  entry: path.resolve(__dirname, 'lib/entry.js'),
  output: {
    path: __dirname + "/bundle/",
    filename: "bundle.js"
  },
  plugins: [
    new OpenBrowserPlugin({ url: 'http://localhost:3000' })
  ]
};

Options

url

Type: String
Default: http://localhost:8080

Url to open when Webpack is ready. Needs to have the prefix http:// or https:// in order to open the browser.

delay

Type: Number
Default: 0
Optional

By default the browser is opened immediately, but this could be too early in some cases (eg. starting a nodeJS server). The value is specified in milliseconds.

browser

Type: String
Optional

Browser to open. By default, it will try to open the browser set by default in your system.

ignoreErrors

Type: Boolean
Default: False
Optional

By default this plugin only opens the browser if there's no Webpack errors. Setting ignoreErrors to true will open a new tab no matter the compilation errors.

Change Log

1.0.0 - 2018-30-05

Fixes

  • Replace open with opn to fix vulnerability.

0.0.5 - 2017-03-09

Fixes

  • Fix issue where the compilation never ends. (Thanks to @vkalinichev)

0.0.4 - 2017-02-19

Fixes

  • Fix issue where other Webpack callbacks were removed. (Thanks to @plemarquand)

0.0.3 - 2016-10-31

Added

  • delay option (Thanks to @Root-Core)

0.0.2 - 2015-12-26

Added

  • ignoreErrors option (Thanks to @zhura).
  • Changelog.
  • Documentation for options.

Removed

  • DEFAULT_BROWSER constant.

0.0.1 - 2015-09-12

  • First release.

License

MIT License.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.