\n\n[![npm][npm]][npm-url]\n[![node][node]][node-url]\n[![deps][deps]][deps-url]\n[![tests][tests]][tests-url]\n[![coverage][cover]][cover-url]\n[![chat][chat]][chat-url]\n[![size][size]][size-url]\n\n# webpack-serve\n\nA lean, modern, and flexible webpack development server\n\n## Requirements\n\nThis module requires a minimum of Node.js v6.9.0 and Webpack v4.0.0.\n\n## Browser Support\n\nBecause this module leverages _native_ `WebSockets` via `webpack-hot-client`,\nthe browser support for this module is limited to only those browsers which\nsupport native `WebSocket`. That typically means the last two major versions\nof a particular browser. You may view a table of\n[compatible browsers here](https://caniuse.com/#feat=websockets).\n\n_Note: We won't be accepting requests for changes to this facet of the module._\n\n## Getting Started\n\nTo begin, you'll need to install `webpack-serve`:\n\n```console\n$ npm install webpack-serve --save-dev\n```\n\n## CLI\n\n```console\n$ webpack-serve --help\n\nA lean, modern, and flexible webpack development server\n\nUsage\n $ webpack-serve [...options]\n\nOptions\n --clipboard Specify whether or not the server should copy the server URI to the clipboard (default: true)\n --config The webpack config to serve. Alias for \n --content The path from which static content will be served (default: process.cwd)\n --dev-ware Set options for webpack-dev-middleware. e.g. --dev.publicPath /\n --help Show usage information and the options listed here.\n --host The host the app should bind to\n --hot-client Set options for webpack-hot-client. e.g. --hot-client.host localhost\n Use --no-hot-client to disable webpack-hot-client\n --http2 Instruct the server to use HTTP2\n --https-cert Specify a filesystem path of an SSL certificate. Must be paired with a key\n --https-key Specify a filesystem path of an SSL key. Must be paired with a cert\n --https-pass Specify a passphrase to enable https. Must be paired with a pfx file\n --https-pfx Specify a filesystem path of an SSL pfx file. Must be paired with a passphrase\n --log-level Limit all process console messages to a specific level and above\n Levels: trace, debug, info, warn, error, silent\n --log-time Instruct the logger for webpack-serve and dependencies to display a timestamp\n --hmr Specify whether or not the client should apply Hot Module Replacement patches (default: true)\n --reload Specify whether or not the middleware should reload the page for build errors (default: true)\n --open Instruct the app to open in the default browser\n --open-app The name of the app to open the app within, or an array\n containing the app name and arguments for the app\n --open-path The path with the app a browser should open to\n --port The port the app should listen on. Default: 8080\n --require, -r Preload one or more modules before loading the webpack configuration\n --version Display the webpack-command version\n\nNote: Any boolean flag can be prefixed with 'no-' instead of specifying a value.\ne.g. --no-reload rather than --reload=false\n\nExamples\n $ webpack-serve ./webpack.config.js --no-reload\n $ webpack-serve --config ./webpack.config.js --port 1337\n $ webpack-serve # config can be omitted for webpack v4+ only\n```\n\n_Note: The CLI will use your local install of webpack-serve when available,\neven when run globally._\n\n### Running the CLI\n\nThere are a few variations for using the base CLI command, and starting\n`webpack-serve`:\n\n```console\n $ webpack-serve ./webpack.config.js\n $ webpack-serve --config ./webpack.config.js\n```\n\nThose two commands are synonymous. Both instruct `webpack-serve` to load the\nconfig from the specified path. We left the flag in there because some folks\nlike to be verbose, so why not.\n\n```console\n $ webpack-serve\n```\n\nYou may also instruct `webpack-serve` to kick off a webpack build without\nspecifying a config. This will apply the zero-config defaults within webpack,\nand your project must conform to that for a successful build to happen.\n\n## `webpack-serve` Config\n\nYou can store and define configuration / options for `webpack-serve` in a number\nof different ways. This module leverages\n[cosmiconfig](https://github.com/davidtheclark/cosmiconfig), which allows you to\ndefine `webpack-serve` options in the following ways:\n\n- in your package.json file in a `serve` property\n- in a `.serverc` or `.serverc.json` file, in either JSON or YML.\n- in a `serve.config.js` file which exports a CommonJS module (just like webpack).\n\nIt's most common to keep `serve` options in your `webpack.config.js` (see below),\nhowever, you can utilize any of the options above _in tandem_ with\n`webpack.config.js`, and the options from the two sources will be merged. This\ncan be useful for setups with multiple configs that share common options for\n`webpack-serve`, but require subtle differences.\n\n### Webpack Config `serve` Property\n\n`webpack-serve` supports the `serve` property in your webpack config file, which\nmay contain any of the supported [options](#options).\n\n### Setting the Config `mode`\n\nShould you find that the `mode` property of your webpack config file needs to be\nset dynamically the following pattern can be used:\n\n```json\n mode: process.env.WEBPACK_SERVE ? 'development' : 'production',\n```\n\n## API\n\nWhen using the API directly, the main entry point is the `serve` function, which\nis the default export of the module.\n\n```js\nconst serve = require('webpack-serve');\nconst argv = {};\nconst config = require('./webpack.config.js');\n\nserve(argv, { config }).then((result) => {\n // ...\n});\n```\n\n## `serve(argv, options)`\n\nReturns: `Promise` \nResolves: `
![](\"https://webpack.js.org/assets/icon-square-big.svg\"){kind=icon}
\n \n