webpack-dev-server 4.0.0-beta.2 → 4.0.0

package/README.md

@@ -55,72 +55,123 @@ The easiest way to use it is with the [webpack CLI](https://webpack.js.org/api/c
 `webpack.config.js` is, run:
 
 ```console
-node_modules/.bin/webpack serve
+npx webpack serve
 ```
 
 Following options are available with `webpack serve`:
 
 ```
-Usage: webpack serve|s [entries...] [options]
+Usage: webpack serve|server|s [entries...] [options]
+
+Run the webpack dev server.
 
 Options:
-  -c, --config <value...>    Provide path to a webpack configuration file e.g. ./webpack.config.js.
-  --config-name <value...>   Name of the configuration to use.
-  -m, --merge                Merge two or more configurations using 'webpack-merge'.
-  --env <value...>           Environment passed to the configuration when it is a function.
-  --node-env <value>         Sets process.env.NODE_ENV to the specified value.
-  --progress [value]         Print compilation progress during build.
-  -j, --json [value]         Prints result as JSON or store it in a file.
-  -d, --devtool <value>      Determine source maps to use.
-  --no-devtool               Do not generate source maps.
-  --entry <value...>         The entry point(s) of your application e.g. ./src/main.js.
-  --mode <value>             Defines the mode to pass to webpack.
-  --name <value>             Name of the configuration. Used when loading multiple configurations.
-  -o, --output-path <value>  Output location of the file generated by webpack e.g. ./dist/.
-  --stats [value]            It instructs webpack on how to treat the stats e.g. verbose.
-  --no-stats                 Disable stats output.
-  -t, --target <value...>    Sets the build target e.g. node.
-  --no-target                Negative 'target' option.
-  --watch-options-stdin      Stop watching when stdin stream has ended.
-  --no-watch-options-stdin   Do not stop watching when stdin stream has ended.
-  --host <value>             The hostname/ip address the server will bind to.
-  --port <value>             The port server will listen to.
-  --static [value...]        A directory to serve static content from.
-  --no-static                Negative 'static' option.
-  --live-reload              Enables live reloading on changing files.
-  --no-live-reload           Disables live reloading on changing files.
-  --https                    Use HTTPS protocol.
-  --no-https                 Do not use HTTPS protocol.
-  --http2                    Use HTTP/2, must be used with HTTPS.
-  --no-http2                 Do not use HTTP/2.
-  --bonjour                  Broadcasts the server via ZeroConf networking on start.
-  --no-bonjour               Do not broadcast the server via ZeroConf networking on start.
-  --client-progress          Print compilation progress in percentage in the browser.
-  --no-client-progress       Do not print compilation progress in percentage in the browser.
-  --client-overlay           Show a full-screen overlay in the browser when there are compiler errors or warnings.
-  --no-client-overlay        Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
-  --setup-exit-signals       Close and exit the process on SIGINT and SIGTERM.
-  --no-setup-exit-signals    Do not close and exit the process on SIGNIT and SIGTERM.
-  --open [value...]          Open the default browser.
-  --no-open                  Do not open the default browser.
-  --open-app <value>         Open specified browser.
-  --open-target [value...]   Open specified route in browser.
-  --no-open-target           Do not open specified route in browser.
-  --client-logging <value>   Log level in the browser (none, error, warn, info, log, verbose).
-  --history-api-fallback     Fallback to /index.html for Single Page Applications.
-  --no-history-api-fallback  Do not fallback to /index.html for Single Page Applications.
-  --compress                 Enable gzip compression.
-  --no-compress              Disable gzip compression.
-  --public <value>           The public hostname/ip address of the server.
-  --firewall [value...]      Enable firewall or set hosts that are allowed to access the dev server.
-  --no-firewall              Disable firewall.
-  --watch-files <value...>   Watch static files for file changes.
+  -c, --config <value...>                   Provide path to a webpack configuration file e.g. ./webpack.config.js.
+  --config-name <value...>                  Name of the configuration to use.
+  -m, --merge                               Merge two or more configurations using 'webpack-merge'.
+  --env <value...>                          Environment passed to the configuration when it is a function.
+  --node-env <value>                        Sets process.env.NODE_ENV to the specified value.
+  --progress [value]                        Print compilation progress during build.
+  -j, --json [value]                        Prints result as JSON or store it in a file.
+  -d, --devtool <value>                     Determine source maps to use.
+  --no-devtool                              Do not generate source maps.
+  --entry <value...>                        The entry point(s) of your application e.g. ./src/main.js.
+  --mode <value>                            Defines the mode to pass to webpack.
+  --name <value>                            Name of the configuration. Used when loading multiple configurations.
+  -o, --output-path <value>                 Output location of the file generated by webpack e.g. ./dist/.
+  --stats [value]                           It instructs webpack on how to treat the stats e.g. verbose.
+  --no-stats                                Disable stats output.
+  -t, --target <value...>                   Sets the build target e.g. node.
+  --no-target                               Negative 'target' option.
+  --watch-options-stdin                     Stop watching when stdin stream has ended.
+  --no-watch-options-stdin                  Do not stop watching when stdin stream has ended.
+  --allowed-hosts <value...>                Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying
+                                            dev server, by default is 'auto').
+  --allowed-hosts-reset                     Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to
+                                            the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
+  --bonjour                                 Allows to broadcasts dev server via ZeroConf networking on start.
+  --no-bonjour                              Negative 'bonjour' option.
+  --no-client                               Negative 'client' option.
+  --client-logging <value>                  Allows to specify options for client script in the browser or disable client script.
+  --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
+  --no-client-overlay                       Negative 'client-overlay' option.
+  --client-overlay-errors                   Enables a full-screen overlay in the browser when there are compiler errors.
+  --no-client-overlay-errors                Negative 'client-overlay-errors' option.
+  --client-overlay-warnings                 Enables a full-screen overlay in the browser when there are compiler warnings.
+  --no-client-overlay-warnings              Negative 'client-overlay-warnings' option.
+  --client-progress                         Prints compilation progress in percentage in the browser.
+  --no-client-progress                      Negative 'client-progress' option.
+  --client-web-socket-transport <value>     Allows to set custom web socket transport to communicate with dev server.
+  --client-web-socket-url <value>           Allows to specify URL to web socket server (useful when you're proxying dev server and client script does
+                                            not always know where to connect to).
+  --client-web-socket-url-hostname <value>  Tells clients connected to devServer to use the provided hostname.
+  --client-web-socket-url-pathname <value>  Tells clients connected to devServer to use the provided path to connect.
+  --client-web-socket-url-password <value>  Tells clients connected to devServer to use the provided password to authenticate.
+  --client-web-socket-url-port <value>      Tells clients connected to devServer to use the provided port.
+  --client-web-socket-url-protocol <value>  Tells clients connected to devServer to use the provided protocol.
+  --client-web-socket-url-username <value>  Tells clients connected to devServer to use the provided username to authenticate.
+  --compress                                Enables gzip compression for everything served.
+  --no-compress                             Negative 'compress' option.
+  --history-api-fallback                    Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page
+                                            Applications that utilise the HTML5 History API.
+  --no-history-api-fallback                 Negative 'history-api-fallback' option.
+  --host <value>                            Allows to specify a hostname to use.
+  --hot [value]                             Enables Hot Module Replacement.
+  --no-hot                                  Negative 'hot' option.
+  --http2                                   Allows to serve over HTTP/2 using SPDY.
+  --no-http2                                Negative 'http2' option.
+  --https                                   Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
+  --no-https                                Negative 'https' option.
+  --https-passphrase <value>                Passphrase for a pfx file.
+  --https-request-cert                      Request for an SSL certificate.
+  --no-https-request-cert                   Negative 'https-request-cert' option.
+  --https-cacert <value>                    Path to an SSL CA certificate.
+  --https-key <value>                       Path to an SSL key.
+  --https-pfx <value>                       Path to an SSL pfx file.
+  --https-cert <value>                      Path to an SSL certificate.
+  --ipc [value]                             Listen to a unix socket.
+  --live-reload                             Enables reload/refresh the page(s) when file changes are detected (enabled by default).
+  --no-live-reload                          Negative 'live-reload' option.
+  --open [value...]                         Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to
+                                            true to open your default browser).
+  --no-open                                 Negative 'open' option.
+  --open-target <value...>                  Opens specified page in browser.
+  --open-app-name <value...>                Open specified browser.
+  --open-app <value...>                     Open specified browser.
+  --open-reset                              Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and
+                                            page(s) after server had been started (set it to true to open your default browser).
+  --open-target-reset                       Clear all items provided in 'open.target' configuration. Opens specified page in browser.
+  --open-app-name-reset                     Clear all items provided in 'open.app.name' configuration. Open specified browser.
+  --port <value>                            Allows to specify a port to use.
+  --static [value...]                       Allows to configure options for serving static files from directory (by default 'public' directory).
+  --no-static                               Negative 'static' option.
+  --static-directory <value...>             Directory for static contents.
+  --static-public-path <value...>           The static files will be available in the browser under this public path.
+  --static-serve-index                      Tells dev server to use serveIndex middleware when enabled.
+  --no-static-serve-index                   Negative 'static-serve-index' option.
+  --static-watch                            Watches for files in static content directory.
+  --no-static-watch                         Negative 'static-watch' option.
+  --static-reset                            Clear all items provided in 'static' configuration. Allows to configure options for serving static files
+                                            from directory (by default 'public' directory).
+  --static-public-path-reset                Clear all items provided in 'static.publicPath' configuration. The static files will be available in the
+                                            browser under this public path.
+  --watch-files <value...>                  Allows to configure list of globs/directories/files to watch for file changes.
+  --watch-files-reset                       Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files
+                                            to watch for file changes.
+  --web-socket-server <value>               Allows to set web socket server and options (by default 'ws').
+  --no-web-socket-server                    Negative 'web-socket-server' option.
 
 Global options:
-  --color                    Enable colors on console.
-  --no-color                 Disable colors on console.
-  -v, --version              Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
-  -h, --help [verbose]       Display help for commands and options.
+  --color                                   Enable colors on console.
+  --no-color                                Disable colors on console.
+  -v, --version                             Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.
+  -h, --help [verbose]                      Display help for commands and options.
+
+To see list of all supported commands and options run 'webpack --help=verbose'.
+
+Webpack documentation: https://webpack.js.org/.
+CLI documentation: https://webpack.js.org/api/cli/.
+Made with ♥ by the webpack team.
 ```
 
 _**Note**: For more information on above options explore this [link](https://webpack.js.org/configuration/dev-server/)._
@@ -142,7 +193,7 @@ script as such:
 And run the following in your terminal/console:
 
 ```console
-npm run start:dev
+npm run serve
 ```
 
 NPM will automagically reference the binary in `node_modules` for you, and