webpack-dev-server 4.8.1 → 4.9.0

package/README.md

@@ -80,137 +80,127 @@ 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.
-  --entry <value...>                        The entry point(s) of your application e.g. ./src/main.js.
-  -o, --output-path <value>                 Output location of the file generated by webpack e.g. ./dist/.
-  -t, --target <value>                      Sets the build target e.g. node.
-  -d, --devtool <value>                     Determine source maps to use.
-  --no-devtool                              Do not generate source maps.
-  --mode <value>                            Defines the mode to pass to webpack.
-  --name <value>                            Name of the configuration. Used when loading multiple configurations.
-  --stats [value]                           It instructs webpack on how to treat the stats e.g. verbose.
-  --no-stats                                Disable stats output.
-  --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                              Disallows to broadcasts dev server via ZeroConf networking on start.
-  --no-client                               Disables client script.
-  --client-logging <value>                  Allows to set log level in the browser.
-  --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
-  --no-client-overlay                       Disables the full-screen overlay in the browser when there are compiler errors or warnings.
-  --client-overlay-errors                   Enables a full-screen overlay in the browser when there are compiler errors.
-  --no-client-overlay-errors                Disables the full-screen overlay in the browser when there are compiler errors.
-  --client-overlay-warnings                 Enables a full-screen overlay in the browser when there are compiler warnings.
-  --no-client-overlay-warnings              Disables the full-screen overlay in the browser when there are compiler warnings.
-  --client-progress                         Prints compilation progress in percentage in the browser.
-  --no-client-progress                      Does not print compilation progress in percentage in the browser.
-  --client-reconnect [value]                Tells dev-server the number of times it should try to reconnect the client.
-  --no-client-reconnect                     Tells dev-server to not to try to reconnect the client.
-  --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-password <value>  Tells clients connected to devServer to use the provided password to authenticate.
-  --client-web-socket-url-pathname <value>  Tells clients connected to devServer to use the provided path to connect.
-  --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                             Disables gzip compression for everything served.
-  --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                 Disallows to proxy requests through a specified index page.
-  --host <value>                            Allows to specify a hostname to use.
-  --hot [value]                             Enables Hot Module Replacement.
-  --no-hot                                  Disables Hot Module Replacement.
-  --http2                                   Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.
-  --no-http2                                Does not serve over HTTP/2 using SPDY.
-  --https                                   Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.
-  --no-https                                Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
-  --https-ca <value...>                     Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
-  --https-ca-reset                          Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the
-                                            `server.options.ca` option.
-  --https-cacert <value...>                 Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
-  --https-cacert-reset                      Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the
-                                            `server.options.ca` option.
-  --https-cert <value...>                   Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.
-  --https-cert-reset                        Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the
-                                            `server.options.cert` option.
-  --https-crl <value...>                    Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the
-                                            `server.options.crl` option.
-  --https-crl-reset                         Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs
-                                            (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.
-  --https-key <value...>                    Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
-  --https-key-reset                         Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
-  --https-passphrase <value>                Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.
-  --https-pfx <value...>                    Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.
-  --https-pfx-reset                         Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the
-                                            `server.options.pfx` option.
-  --https-request-cert                      Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.
-  --no-https-request-cert                   Does not request for 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                          Disables reload/refresh the page(s) when file changes are detected (enabled by default)
-  --magic-html                              Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').
-  --no-magic-html                           Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').
-  --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                                 Does not open the default browser.
-  --open-app <value...>                     Open specified browser. Deprecated: please use '--open-app-name'.
-  --open-app-name <value...>                Open specified browser.
-  --open-app-name-reset                     Clear all items provided in 'open.app.name' configuration. 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 <value...>                  Opens specified page in browser.
-  --open-target-reset                       Clear all items provided in 'open.target' configuration. Opens specified page in browser.
-  --port <value>                            Allows to specify a port to use.
-  --server-options-ca <value...>            Path to an SSL CA certificate or content of an SSL CA certificate.
-  --server-options-ca-reset                 Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate.
-  --server-options-cacert <value...>        Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
-  --server-options-cacert-reset             Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated,
-                                            use the `server.options.ca` option.
-  --server-options-cert <value...>          Path to an SSL certificate or content of an SSL certificate.
-  --server-options-cert-reset               Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content of an SSL certificate.
-  --server-options-crl <value...>           Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).
-  --server-options-crl-reset                Clear all items provided in 'server.options.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM
-                                            formatted CRLs (Certificate Revocation Lists).
-  --server-options-key <value...>           Path to an SSL key or content of an SSL key.
-  --server-options-key-reset                Clear all items provided in 'server.options.key' configuration. Path to an SSL key or content of an SSL key.
-  --server-options-passphrase <value>       Passphrase for a pfx file.
-  --server-options-pfx <value...>           Path to an SSL pfx file or content of an SSL pfx file.
-  --server-options-pfx-reset                Clear all items provided in 'server.options.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file.
-  --server-options-request-cert             Request for an SSL certificate.
-  --no-server-options-request-cert          Negative 'server-options-request-cert' option.
-  --server-type <value>                     Allows to set server and options (by default 'http').
-  --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-public-path-reset                Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.
-  --static-reset                            Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public'
-                                            directory).
-  --static-serve-index                      Tells dev server to use serveIndex middleware when enabled.
-  --no-static-serve-index                   Does not tell dev server to use serveIndex middleware.
-  --static-watch                            Watches for files in static content directory.
-  --no-static-watch                         Does not watch for files in static content directory.
-  --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>               Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
-  --no-web-socket-server                    Negative 'web-socket-server' option.
-  --web-socket-server-type <value>          Allows to set web socket server and options (by default 'ws').
+  -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                                        Disallows to broadcasts dev server via ZeroConf networking on start.
+  --no-client                                         Disables client script.
+  --client-logging <value>                            Allows to set log level in the browser.
+  --client-overlay                                    Enables a full-screen overlay in the browser when there are compiler errors or warnings.
+  --no-client-overlay                                 Disables the full-screen overlay in the browser when there are compiler errors or warnings.
+  --client-overlay-errors                             Enables a full-screen overlay in the browser when there are compiler errors.
+  --no-client-overlay-errors                          Disables the full-screen overlay in the browser when there are compiler errors.
+  --client-overlay-warnings                           Enables a full-screen overlay in the browser when there are compiler warnings.
+  --no-client-overlay-warnings                        Disables the full-screen overlay in the browser when there are compiler warnings.
+  --client-overlay-trusted-types-policy-name <value>  The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.
+  --client-progress                                   Prints compilation progress in percentage in the browser.
+  --no-client-progress                                Does not print compilation progress in percentage in the browser.
+  --client-reconnect [value]                          Tells dev-server the number of times it should try to reconnect the client.
+  --no-client-reconnect                               Tells dev-server to not to try to reconnect the client.
+  --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                                       Disables gzip compression for everything served.
+  --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                           Disallows to proxy requests through a specified index page.
+  --host <value>                                      Allows to specify a hostname to use.
+  --hot [value]                                       Enables Hot Module Replacement.
+  --no-hot                                            Disables Hot Module Replacement.
+  --http2                                             Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.
+  --no-http2                                          Does not serve over HTTP/2 using SPDY.
+  --https                                             Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.
+  --no-https                                          Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
+  --https-passphrase <value>                          Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.
+  --https-request-cert                                Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.
+  --no-https-request-cert                             Does not request for an SSL certificate.
+  --https-ca <value...>                               Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --https-ca-reset                                    Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --https-cacert <value...>                           Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --https-cacert-reset                                Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --https-cert <value...>                             Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.
+  --https-cert-reset                                  Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.
+  --https-crl <value...>                              Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.
+  --https-crl-reset                                   Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.
+  --https-key <value...>                              Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
+  --https-key-reset                                   Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
+  --https-pfx <value...>                              Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.
+  --https-pfx-reset                                   Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.
+  --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                                    Disables reload/refresh the page(s) when file changes are detected (enabled by default).
+  --magic-html                                        Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').
+  --no-magic-html                                     Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').
+  --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                                           Does not open the default browser.
+  --open-target <value...>                            Opens specified page in browser.
+  --open-app-name <value...>                          Open specified browser.
+  --open-app <value...>                               Open specified browser. Deprecated: please use '--open-app-name'.
+  --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.
+  --server-type <value>                               Allows to set server and options (by default 'http').
+  --server-options-passphrase <value>                 Passphrase for a pfx file.
+  --server-options-request-cert                       Request for an SSL certificate.
+  --no-server-options-request-cert                    Does not request for an SSL certificate.
+  --server-options-ca <value...>                      Path to an SSL CA certificate or content of an SSL CA certificate.
+  --server-options-ca-reset                           Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate.
+  --server-options-cacert <value...>                  Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --server-options-cacert-reset                       Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
+  --server-options-cert <value...>                    Path to an SSL certificate or content of an SSL certificate.
+  --server-options-cert-reset                         Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content of an SSL certificate.
+  --server-options-crl <value...>                     Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).
+  --server-options-crl-reset                          Clear all items provided in 'server.options.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).
+  --server-options-key <value...>                     Path to an SSL key or content of an SSL key.
+  --server-options-key-reset                          Clear all items provided in 'server.options.key' configuration. Path to an SSL key or content of an SSL key.
+  --server-options-pfx <value...>                     Path to an SSL pfx file or content of an SSL pfx file.
+  --server-options-pfx-reset                          Clear all items provided in 'server.options.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file.
+  --static [value...]                                 Allows to configure options for serving static files from directory (by default 'public' directory).
+  --no-static                                         Disallows to configure options for serving static files from directory.
+  --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                             Does not tell dev server to use serveIndex middleware.
+  --static-watch                                      Watches for files in static content directory.
+  --no-static-watch                                   Does not watch for files in static content directory.
+  --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>                         Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
+  --no-web-socket-server                              Disallows to set web socket server and options.
+  --web-socket-server-type <value>                    Allows to set web socket server and options (by default 'ws').
 
 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'.
 
@@ -241,7 +231,7 @@ And run the following in your terminal/console:
 npm run serve
 ```
 
-NPM will automagically reference the binary in `node_modules` for you, and
+NPM will automatically refer to the the binary in `node_modules` for you, and
 execute the file or command.
 
 ### With the API

package/bin/cli-flags.js

@@ -121,6 +121,21 @@ module.exports = {
     simpleType: "boolean",
     multiple: false,
   },
+  "client-overlay-trusted-types-policy-name": {
+    configs: [
+      {
+        description:
+          "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
+        multiple: false,
+        path: "client.overlay.trustedTypesPolicyName",
+        type: "string",
+      },
+    ],
+    description:
+      "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
+    multiple: false,
+    simpleType: "string",
+  },
   "client-overlay-warnings": {
     configs: [
       {

package/client/index.js

@@ -14,7 +14,7 @@ import createSocketURL from "./utils/createSocketURL.js";
  * @property {boolean} hot
  * @property {boolean} liveReload
  * @property {boolean} progress
- * @property {boolean | { warnings?: boolean, errors?: boolean }} overlay
+ * @property {boolean | { warnings?: boolean, errors?: boolean, trustedTypesPolicyName?: string }} overlay
  * @property {string} [logging]
  * @property {number} [reconnect]
  */
@@ -216,7 +216,8 @@ var onSocketMessage = {
     var needShowOverlayForWarnings = typeof options.overlay === "boolean" ? options.overlay : options.overlay && options.overlay.warnings;
 
     if (needShowOverlayForWarnings) {
-      show("warning", _warnings);
+      var trustedTypesPolicyName = typeof options.overlay === "object" && options.overlay.trustedTypesPolicyName;
+      show("warning", _warnings, trustedTypesPolicyName || null);
     }
 
     if (params && params.preventReloading) {
@@ -249,7 +250,8 @@ var onSocketMessage = {
     var needShowOverlayForErrors = typeof options.overlay === "boolean" ? options.overlay : options.overlay && options.overlay.errors;
 
     if (needShowOverlayForErrors) {
-      show("error", _errors);
+      var trustedTypesPolicyName = typeof options.overlay === "object" && options.overlay.trustedTypesPolicyName;
+      show("error", _errors, trustedTypesPolicyName || null);
     }
   },
 

package/client/overlay.js

@@ -23,9 +23,24 @@ var containerElement;
 /** @type {Array<(element: HTMLDivElement) => void>} */
 
 var onLoadQueue = [];
+/** @type {TrustedTypePolicy | undefined} */
+
+var overlayTrustedTypesPolicy;
 ansiHTML.setColors(colors);
+/**
+ * @param {string | null} trustedTypesPolicyName
+ */
+
+function createContainer(trustedTypesPolicyName) {
+  // Enable Trusted Types if they are available in the current browser.
+  if (window.trustedTypes) {
+    overlayTrustedTypesPolicy = window.trustedTypes.createPolicy(trustedTypesPolicyName || "webpack-dev-server#overlay", {
+      createHTML: function createHTML(value) {
+        return value;
+      }
+    });
+  }
 
-function createContainer() {
   iframeContainerElement = document.createElement("iframe");
   iframeContainerElement.id = "webpack-dev-server-client-overlay";
   iframeContainerElement.src = "about:blank";
@@ -101,10 +116,11 @@ function createContainer() {
 }
 /**
  * @param {(element: HTMLDivElement) => void} callback
+ * @param {string | null} trustedTypesPolicyName
  */
 
 
-function ensureOverlayExists(callback) {
+function ensureOverlayExists(callback, trustedTypesPolicyName) {
   if (containerElement) {
     // Everything is ready, call the callback right away.
     callback(containerElement);
@@ -117,7 +133,7 @@ function ensureOverlayExists(callback) {
     return;
   }
 
-  createContainer();
+  createContainer(trustedTypesPolicyName);
 } // Successful compilation.
 
 
@@ -162,10 +178,11 @@ function formatProblem(type, item) {
 /**
  * @param {string} type
  * @param {Array<string  | { file?: string, moduleName?: string, loc?: string, message?: string }>} messages
+ * @param {string | null} trustedTypesPolicyName
  */
 
 
-function show(type, messages) {
+function show(type, messages, trustedTypesPolicyName) {
   ensureOverlayExists(function () {
     messages.forEach(function (message) {
       var entryElement = document.createElement("div");
@@ -180,7 +197,7 @@ function show(type, messages) {
 
       var text = ansiHTML(encode(body));
       var messageTextNode = document.createElement("div");
-      messageTextNode.innerHTML = text;
+      messageTextNode.innerHTML = overlayTrustedTypesPolicy ? overlayTrustedTypesPolicy.createHTML(text) : text;
       entryElement.appendChild(typeElement);
       entryElement.appendChild(document.createElement("br"));
       entryElement.appendChild(document.createElement("br"));
@@ -191,7 +208,7 @@ function show(type, messages) {
 
       containerElement.appendChild(entryElement);
     });
-  });
+  }, trustedTypesPolicyName);
 }
 
 export { formatProblem, show, hide };

package/client/utils/createSocketURL.js

@@ -5,7 +5,7 @@
 function format(objURL) {
   var protocol = objURL.protocol || "";
 
-  if (protocol && !protocol.endsWith(":")) {
+  if (protocol && protocol.substr(-1) !== ":") {
     protocol += ":";
   }
 

package/lib/Server.js

@@ -385,17 +385,17 @@ class Server {
 
   /**
    * @param {Port} port
+   * @param {string} host
    * @returns {Promise<number | string>}
    */
-  static async getFreePort(port) {
+  static async getFreePort(port, host) {
     if (typeof port !== "undefined" && port !== null && port !== "auto") {
       return port;
     }
 
     const pRetry = require("p-retry");
-    const portfinder = require("portfinder");
-
-    portfinder.basePort =
+    const getPort = require("./getPort");
+    const basePort =
       typeof process.env.WEBPACK_DEV_SERVER_BASE_PORT !== "undefined"
         ? parseInt(process.env.WEBPACK_DEV_SERVER_BASE_PORT, 10)
         : 8080;
@@ -407,7 +407,7 @@ class Server {
         ? parseInt(process.env.WEBPACK_DEV_SERVER_PORT_RETRY, 10)
         : 3;
 
-    return pRetry(() => portfinder.getPortPromise(), {
+    return pRetry(() => getPort(basePort, host), {
       retries: defaultPortRetry,
     });
   }
@@ -3201,7 +3201,8 @@ class Server {
         /** @type {Host} */ (this.options.host)
       );
       this.options.port = await Server.getFreePort(
-        /** @type {Port} */ (this.options.port)
+        /** @type {Port} */ (this.options.port),
+        this.options.host
       );
     }
 

package/lib/getPort.js

@@ -0,0 +1,133 @@
+"use strict";
+
+/*
+ * Based on the packages get-port https://www.npmjs.com/package/get-port
+ * and portfinder https://www.npmjs.com/package/portfinder
+ * The code structure is similar to get-port, but it searches
+ * ports deterministically like portfinder
+ */
+const net = require("net");
+const os = require("os");
+
+const minPort = 1024;
+const maxPort = 65_535;
+
+/**
+ * @return {Set<string|undefined>}
+ */
+const getLocalHosts = () => {
+  const interfaces = os.networkInterfaces();
+
+  // Add undefined value for createServer function to use default host,
+  // and default IPv4 host in case createServer defaults to IPv6.
+  // eslint-disable-next-line no-undefined
+  const results = new Set([undefined, "0.0.0.0"]);
+
+  for (const _interface of Object.values(interfaces)) {
+    if (_interface) {
+      for (const config of _interface) {
+        results.add(config.address);
+      }
+    }
+  }
+
+  return results;
+};
+
+/**
+ * @param {number} basePort
+ * @param {string | undefined} host
+ * @return {Promise<number>}
+ */
+const checkAvailablePort = (basePort, host) =>
+  new Promise((resolve, reject) => {
+    const server = net.createServer();
+    server.unref();
+    server.on("error", reject);
+
+    server.listen(basePort, host, () => {
+      // Next line should return AdressInfo because we're calling it after listen() and before close()
+      const { port } = /** @type {import("net").AddressInfo} */ (
+        server.address()
+      );
+      server.close(() => {
+        resolve(port);
+      });
+    });
+  });
+
+/**
+ * @param {number} port
+ * @param {Set<string|undefined>} hosts
+ * @return {Promise<number>}
+ */
+const getAvailablePort = async (port, hosts) => {
+  /**
+   * Errors that mean that host is not available.
+   * @type {Set<string | undefined>}
+   */
+  const nonExistentInterfaceErrors = new Set(["EADDRNOTAVAIL", "EINVAL"]);
+  /* Check if the post is available on every local host name */
+  for (const host of hosts) {
+    try {
+      await checkAvailablePort(port, host); // eslint-disable-line no-await-in-loop
+    } catch (error) {
+      /* We throw an error only if the interface exists */
+      if (
+        !nonExistentInterfaceErrors.has(
+          /** @type {NodeJS.ErrnoException} */ (error).code
+        )
+      ) {
+        throw error;
+      }
+    }
+  }
+
+  return port;
+};
+
+/**
+ * @param {number} basePort
+ * @param {string=} host
+ * @return {Promise<number>}
+ */
+async function getPorts(basePort, host) {
+  if (basePort < minPort || basePort > maxPort) {
+    throw new Error(`Port number must lie between ${minPort} and ${maxPort}`);
+  }
+
+  let port = basePort;
+  const localhosts = getLocalHosts();
+  let hosts;
+  if (host && !localhosts.has(host)) {
+    hosts = new Set([host]);
+  } else {
+    /* If the host is equivalent to localhost
+       we need to check every equivalent host
+       else the port might falsely appear as available
+       on some operating systems  */
+    hosts = localhosts;
+  }
+  /** @type {Set<string | undefined>} */
+  const portUnavailableErrors = new Set(["EADDRINUSE", "EACCES"]);
+  while (port <= maxPort) {
+    try {
+      const availablePort = await getAvailablePort(port, hosts); // eslint-disable-line no-await-in-loop
+      return availablePort;
+    } catch (error) {
+      /* Try next port if port is busy; throw for any other error */
+      if (
+        !portUnavailableErrors.has(
+          /** @type {NodeJS.ErrnoException} */ (error).code
+        )
+      ) {
+        throw error;
+      }
+      port += 1;
+    }
+  }
+
+  throw new Error("No available ports found");
+}
+
+module.exports = getPorts;

package/lib/options.json

@@ -110,6 +110,10 @@
               "cli": {
                 "negatedDescription": "Disables the full-screen overlay in the browser when there are compiler warnings."
               }
+            },
+            "trustedTypesPolicyName": {
+              "description": "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
+              "type": "string"
             }
           }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-server",
-  "version": "4.8.1",
+  "version": "4.9.0",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
@@ -55,7 +55,6 @@
     "ipaddr.js": "^2.0.1",
     "open": "^8.0.9",
     "p-retry": "^4.5.0",
-    "portfinder": "^1.0.28",
     "rimraf": "^3.0.2",
     "schema-utils": "^4.0.0",
     "selfsigned": "^2.0.1",
@@ -79,6 +78,7 @@
     "@types/default-gateway": "^3.0.1",
     "@types/rimraf": "^3.0.2",
     "@types/sockjs-client": "^1.5.1",
+    "@types/trusted-types": "^2.0.2",
     "acorn": "^8.2.4",
     "babel-jest": "^27.5.1",
     "babel-loader": "^8.2.4",

package/types/bin/cli-flags.d.ts

@@ -91,6 +91,17 @@ declare const _exports: {
     simpleType: string;
     multiple: boolean;
   };
+  "client-overlay-trusted-types-policy-name": {
+    configs: {
+      description: string;
+      multiple: boolean;
+      path: string;
+      type: string;
+    }[];
+    description: string;
+    multiple: boolean;
+    simpleType: string;
+  };
   "client-overlay-warnings": {
     configs: {
       type: string;

package/types/lib/Server.d.ts

@@ -393,6 +393,17 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      "client-overlay-trusted-types-policy-name": {
+        configs: {
+          description: string;
+          multiple: boolean;
+          path: string;
+          type: string;
+        }[];
+        description: string;
+        multiple: boolean;
+        simpleType: string;
+      };
       "client-overlay-warnings": {
         configs: {
           type: string;
@@ -417,6 +428,60 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      /**
+       * @typedef {Object} WebSocketURL
+       * @property {string} [hostname]
+       * @property {string} [password]
+       * @property {string} [pathname]
+       * @property {number | string} [port]
+       * @property {string} [protocol]
+       * @property {string} [username]
+       */
+      /**
+       * @typedef {Object} ClientConfiguration
+       * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+       * @property {boolean  | { warnings?: boolean, errors?: boolean }} [overlay]
+       * @property {boolean} [progress]
+       * @property {boolean | number} [reconnect]
+       * @property {"ws" | "sockjs" | string} [webSocketTransport]
+       * @property {string | WebSocketURL} [webSocketURL]
+       */
+      /**
+       * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
+       */
+      /**
+       * @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
+       */
+      /**
+       * @typedef {Object} Configuration
+       * @property {boolean | string} [ipc]
+       * @property {Host} [host]
+       * @property {Port} [port]
+       * @property {boolean | "only"} [hot]
+       * @property {boolean} [liveReload]
+       * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
+       * @property {boolean} [compress]
+       * @property {boolean} [magicHtml]
+       * @property {"auto" | "all" | string | string[]} [allowedHosts]
+       * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+       * @property {boolean} [setupExitSignals]
+       * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
+       * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
+       * @property {boolean | string | Static | Array<string | Static>} [static]
+       * @property {boolean | ServerOptions} [https]
+       * @property {boolean} [http2]
+       * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
+       * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
+       * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
+       * @property {boolean | string | Open | Array<string | Open>} [open]
+       * @property {boolean} [setupExitSignals]
+       * @property {boolean | ClientConfiguration} [client]
+       * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
+       * @property {(devServer: Server) => void} [onAfterSetupMiddleware]
+       * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
+       * @property {(devServer: Server) => void} [onListening]
+       * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+       */
       "client-reconnect": {
         configs: (
           | {
@@ -453,36 +518,6 @@ declare class Server {
               path: string;
             }
         )[];
-        /**
-         * @typedef {Object} Configuration
-         * @property {boolean | string} [ipc]
-         * @property {Host} [host]
-         * @property {Port} [port]
-         * @property {boolean | "only"} [hot]
-         * @property {boolean} [liveReload]
-         * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
-         * @property {boolean} [compress]
-         * @property {boolean} [magicHtml]
-         * @property {"auto" | "all" | string | string[]} [allowedHosts]
-         * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
-         * @property {boolean} [setupExitSignals]
-         * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
-         * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
-         * @property {boolean | string | Static | Array<string | Static>} [static]
-         * @property {boolean | ServerOptions} [https]
-         * @property {boolean} [http2]
-         * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
-         * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
-         * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
-         * @property {boolean | string | Open | Array<string | Open>} [open]
-         * @property {boolean} [setupExitSignals]
-         * @property {boolean | ClientConfiguration} [client]
-         * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
-         * @property {(devServer: Server) => void} [onAfterSetupMiddleware]
-         * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
-         * @property {(devServer: Server) => void} [onListening]
-         * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
-         */
         description: string;
         simpleType: string;
         multiple: boolean;
@@ -539,6 +574,9 @@ declare class Server {
           path: string;
         }[];
         description: string;
+        /**
+         * @type {FSWatcher[]}
+         */
         simpleType: string;
         multiple: boolean;
       };
@@ -558,20 +596,12 @@ declare class Server {
               type: string;
             }
         )[];
-        /**
-         * @private
-         * @type {{ name: string | symbol, listener: (...args: any[]) => void}[] }}
-         */
         description: string;
         multiple: boolean;
         simpleType: string;
       };
       "client-web-socket-url-username": {
         configs: {
-          /**
-           * @private
-           * @type {RequestHandler[]}
-           */
           type: string;
           multiple: boolean;
           description: string;
@@ -581,6 +611,10 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      /**
+       * @param {string} URL
+       * @returns {boolean}
+       */
       compress: {
         configs: {
           type: string;
@@ -591,6 +625,10 @@ declare class Server {
         }[];
         description: string;
         simpleType: string;
+        /**
+         * @param {string} gateway
+         * @returns {string | undefined}
+         */
         multiple: boolean;
       };
       "history-api-fallback": {
@@ -623,6 +661,10 @@ declare class Server {
         )[];
         description: string;
         simpleType: string;
+        /**
+         * @param {Host} hostname
+         * @returns {Promise<string>}
+         */
         multiple: boolean;
       };
       hot: {
@@ -632,10 +674,6 @@ declare class Server {
               multiple: boolean;
               description: string;
               negatedDescription: string;
-              /**
-               * @param {"v4" | "v6"} family
-               * @returns {string | undefined}
-               */
               path: string;
             }
           | {
@@ -662,10 +700,6 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
-      /**
-       * @param {Port} port
-       * @returns {Promise<number | string>}
-       */
       https: {
         configs: {
           type: string;
@@ -685,9 +719,6 @@ declare class Server {
           description: string;
           path: string;
         }[];
-        /**
-         * @type {string | undefined}
-         */
         description: string;
         simpleType: string;
         multiple: boolean;
@@ -695,6 +726,9 @@ declare class Server {
       "https-ca-reset": {
         configs: {
           description: string;
+          /**
+           * @type {string[]}
+           */
           multiple: boolean;
           path: string;
           type: string;
@@ -719,7 +753,7 @@ declare class Server {
           description: string;
           multiple: boolean;
           path: string;
-          /** @type {WebSocketURL} */ type: string;
+          type: string;
         }[];
         description: string;
         multiple: boolean;
@@ -829,7 +863,7 @@ declare class Server {
           type: string;
           multiple: boolean;
           description: string;
-          negatedDescription: string;
+          /** @type {Object<string,string>} */ negatedDescription: string;
           path: string;
         }[];
         description: string;
@@ -841,12 +875,13 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
+              /** @type {any} */
               description: string;
               path: string;
             }
           | {
               type: string;
-              /** @type {Object<string,string>} */ values: boolean[];
+              /** @type {any} */ values: boolean[];
               multiple: boolean;
               description: string;
               path: string;
@@ -896,7 +931,7 @@ declare class Server {
               path: string;
             }
         )[];
-        description: string;
+        /** @type {Compiler} */ description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -952,7 +987,7 @@ declare class Server {
           path: string;
         }[];
         description: string;
-        simpleType: string;
+        /** @type {NormalizedStatic} */ simpleType: string;
         multiple: boolean;
       };
       "open-target-reset": {
@@ -1127,8 +1162,9 @@ declare class Server {
         }[];
         description: string;
         multiple: boolean;
-        simpleType: string;
+        simpleType: string /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       "server-options-request-cert": {
         configs: {
           description: string;
@@ -1164,6 +1200,10 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
+              /**
+               * @param {string | Buffer | undefined} item
+               * @returns {string | Buffer | undefined}
+               */
               description: string;
               negatedDescription: string;
               path: string;
@@ -1180,7 +1220,7 @@ declare class Server {
           description: string;
           path: string;
         }[];
-        description: string;
+        /** @type {any} */ description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -1287,7 +1327,9 @@ declare class Server {
               type: string;
             }
         )[];
+        /** @type {ServerOptions & { cacert?: ServerOptions["ca"] }} */
         description: string;
+        /** @type {ServerOptions} */
         simpleType: string;
         multiple: boolean;
       };
@@ -1603,6 +1645,10 @@ declare class Server {
                     negatedDescription: string;
                   };
                 };
+                trustedTypesPolicyName: {
+                  description: string;
+                  type: string;
+                };
               };
               description?: undefined;
               link?: undefined;
@@ -1621,21 +1667,103 @@ declare class Server {
       ClientReconnect: {
         description: string;
         link: string;
-        /**
-         * @callback ByPass
-         * @param {Request} req
-         * @param {Response} res
-         * @param {ProxyConfigArrayItem} proxyConfig
-         */
-        /**
-         * @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
-         */
-        /**
-         * @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
-         */
-        /**
-         * @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
-         */
+        anyOf: (
+          | {
+              /**
+               * @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
+               */
+              /**
+               * @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
+               */
+              /**
+               * @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
+               */
+              /**
+               * @typedef {Object} OpenApp
+               * @property {string} [name]
+               * @property {string[]} [arguments]
+               */
+              /**
+               * @typedef {Object} Open
+               * @property {string | string[] | OpenApp} [app]
+               * @property {string | string[]} [target]
+               */
+              /**
+               * @typedef {Object} NormalizedOpen
+               * @property {string} target
+               * @property {import("open").Options} options
+               */
+              /**
+               * @typedef {Object} WebSocketURL
+               * @property {string} [hostname]
+               * @property {string} [password]
+               * @property {string} [pathname]
+               * @property {number | string} [port]
+               * @property {string} [protocol]
+               * @property {string} [username]
+               */
+              /**
+               * @typedef {Object} ClientConfiguration
+               * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+               * @property {boolean  | { warnings?: boolean, errors?: boolean }} [overlay]
+               * @property {boolean} [progress]
+               * @property {boolean | number} [reconnect]
+               * @property {"ws" | "sockjs" | string} [webSocketTransport]
+               * @property {string | WebSocketURL} [webSocketURL]
+               */
+              /**
+               * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
+               */
+              /**
+               * @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
+               */
+              /**
+               * @typedef {Object} Configuration
+               * @property {boolean | string} [ipc]
+               * @property {Host} [host]
+               * @property {Port} [port]
+               * @property {boolean | "only"} [hot]
+               * @property {boolean} [liveReload]
+               * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
+               * @property {boolean} [compress]
+               * @property {boolean} [magicHtml]
+               * @property {"auto" | "all" | string | string[]} [allowedHosts]
+               * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+               * @property {boolean} [setupExitSignals]
+               * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
+               * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
+               * @property {boolean | string | Static | Array<string | Static>} [static]
+               * @property {boolean | ServerOptions} [https]
+               * @property {boolean} [http2]
+               * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
+               * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
+               * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
+               * @property {boolean | string | Open | Array<string | Open>} [open]
+               * @property {boolean} [setupExitSignals]
+               * @property {boolean | ClientConfiguration} [client]
+               * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
+               * @property {(devServer: Server) => void} [onAfterSetupMiddleware]
+               * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
+               * @property {(devServer: Server) => void} [onListening]
+               * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+               */
+              type: string;
+              cli: {
+                negatedDescription: string;
+              };
+              minimum?: undefined;
+            }
+          | {
+              type: string;
+              minimum: number;
+              cli?: undefined /** @typedef {import("express").Request} Request */;
+            }
+        )[];
+      };
+      ClientWebSocketTransport: {
+        anyOf: {
+          $ref: string;
+        }[];
         /**
          * @typedef {Object} OpenApp
          * @property {string} [name]
@@ -1705,25 +1833,6 @@ declare class Server {
          * @property {(devServer: Server) => void} [onListening]
          * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
          */
-        anyOf: (
-          | {
-              type: string;
-              cli: {
-                negatedDescription: string;
-              };
-              minimum?: undefined;
-            }
-          | {
-              type: string;
-              minimum: number;
-              cli?: undefined /** @typedef {import("express").Request} Request */;
-            }
-        )[];
-      };
-      ClientWebSocketTransport: {
-        anyOf: {
-          $ref: string;
-        }[];
         description: string;
         link: string;
       };
@@ -1733,6 +1842,15 @@ declare class Server {
       ClientWebSocketTransportString: {
         type: string;
         minLength: number;
+        /**
+         * @typedef {Object} WebSocketURL
+         * @property {string} [hostname]
+         * @property {string} [password]
+         * @property {string} [pathname]
+         * @property {number | string} [port]
+         * @property {string} [protocol]
+         * @property {string} [username]
+         */
       };
       ClientWebSocketURL: {
         description: string;
@@ -1757,9 +1875,6 @@ declare class Server {
                   description: string;
                   type: string;
                 };
-                /**
-                 * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
-                 */
                 password: {
                   description: string;
                   type: string;
@@ -1873,10 +1988,6 @@ declare class Server {
                       }
                     | {
                         instanceof: string;
-                        /**
-                         * @private
-                         * @type {RequestHandler[]}
-                         */
                         type?: undefined;
                         items?: undefined;
                       }
@@ -1946,6 +2057,10 @@ declare class Server {
                   description: string;
                 };
                 crl: {
+                  /**
+                   * @param {"v4" | "v6"} family
+                   * @returns {Promise<string | undefined>}
+                   */
                   anyOf: (
                     | {
                         type: string;
@@ -2100,7 +2215,7 @@ declare class Server {
             }
         )[];
         description: string;
-        link: string;
+        link: string /** @type {WebSocketURL} */;
       };
       HistoryApiFallback: {
         anyOf: (
@@ -2116,11 +2231,12 @@ declare class Server {
               type: string;
               description: string;
               link: string;
+              /** @type {string} */
               cli?: undefined /** @typedef {import("express").Request} Request */;
             }
         )[];
         description: string;
-        /** @type {string} */ link: string;
+        link: string;
       };
       Host: {
         description: string;
@@ -2258,6 +2374,12 @@ declare class Server {
                       anyOf: (
                         | {
                             type: string;
+                            /**
+                             * prependEntry Method for webpack 4
+                             * @param {any} originalEntry
+                             * @param {any} newAdditionalEntries
+                             * @returns {any}
+                             */
                             items: {
                               type: string;
                               minLength: number;
@@ -2299,6 +2421,7 @@ declare class Server {
           };
         };
       };
+      /** @type {any} */
       OpenString: {
         type: string;
         minLength: number;
@@ -2346,7 +2469,7 @@ declare class Server {
                     }
                   | {
                       instanceof: string;
-                      /** @type {string} */ type?: undefined;
+                      type?: undefined;
                     }
                 )[];
               };
@@ -2508,6 +2631,7 @@ declare class Server {
                     anyOf: (
                       | {
                           type: string;
+                          /** @type {NormalizedStatic} */
                           instanceof?: undefined;
                         }
                       | {
@@ -2812,7 +2936,7 @@ declare class Server {
             }
         )[];
         cli: {
-          description: string;
+          description: string /** @type {any} */;
         };
       };
       WebSocketServerFunction: {
@@ -2850,7 +2974,6 @@ declare class Server {
         $ref: string;
       };
       client: {
-        /** @type {any} */
         $ref: string;
       };
       compress: {
@@ -2951,9 +3074,10 @@ declare class Server {
   static getHostname(hostname: Host): Promise<string>;
   /**
    * @param {Port} port
+   * @param {string} host
    * @returns {Promise<number | string>}
    */
-  static getFreePort(port: Port): Promise<number | string>;
+  static getFreePort(port: Port, host: string): Promise<number | string>;
   /**
    * @returns {string}
    */

package/types/lib/getPort.d.ts

@@ -0,0 +1,10 @@
+export = getPorts;
+/**
+ * @param {number} basePort
+ * @param {string=} host
+ * @return {Promise<number>}
+ */
+declare function getPorts(
+  basePort: number,
+  host?: string | undefined
+): Promise<number>;