webpack-dev-server 4.7.3 → 4.7.4

package/bin/cli-flags.js

@@ -46,13 +46,13 @@ module.exports = {
         multiple: false,
         description:
           "Allows to broadcasts dev server via ZeroConf networking on start.",
+        negatedDescription:
+          "Disallows to broadcasts dev server via ZeroConf networking on start.",
         path: "bonjour",
       },
     ],
     description:
       "Allows to broadcasts dev server via ZeroConf networking on start.",
-    negatedDescription:
-      "Disallows to broadcasts dev server via ZeroConf networking on start.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -93,13 +93,13 @@ module.exports = {
         multiple: false,
         description:
           "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
+        negatedDescription:
+          "Disables a full-screen overlay in the browser when there are compiler errors or warnings.",
         path: "client.overlay",
       },
     ],
     description:
       "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
-    negatedDescription:
-      "Disables a full-screen overlay in the browser when there are compiler errors or warnings.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -140,12 +140,12 @@ module.exports = {
         multiple: false,
         description:
           "Prints compilation progress in percentage in the browser.",
+        negatedDescription:
+          "Does not print compilation progress in percentage in the browser.",
         path: "client.progress",
       },
     ],
     description: "Prints compilation progress in percentage in the browser.",
-    negatedDescription:
-      "Does not print compilation progress in percentage in the browser.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -156,6 +156,8 @@ module.exports = {
         multiple: false,
         description:
           "Tells dev-server the number of times it should try to reconnect the client.",
+        negatedDescription:
+          "Tells dev-server to not to try to connect the client.",
         path: "client.reconnect",
       },
       {
@@ -163,12 +165,13 @@ module.exports = {
         multiple: false,
         description:
           "Tells dev-server the number of times it should try to reconnect the client.",
+        negatedDescription:
+          "Tells dev-server to not to try to connect the client.",
         path: "client.reconnect",
       },
     ],
     description:
       "Tells dev-server the number of times it should try to reconnect the client.",
-    negatedDescription: "Tells dev-server to not to try to connect the client.",
     simpleType: "string",
     multiple: false,
   },
@@ -321,11 +324,11 @@ module.exports = {
         type: "boolean",
         multiple: false,
         description: "Enables gzip compression for everything served.",
+        negatedDescription: "Disables gzip compression for everything served.",
         path: "compress",
       },
     ],
     description: "Enables gzip compression for everything served.",
-    negatedDescription: "Disables gzip compression for everything served.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -370,6 +373,7 @@ module.exports = {
         type: "boolean",
         multiple: false,
         description: "Enables Hot Module Replacement.",
+        negatedDescription: "Disables Hot Module Replacement.",
         path: "hot",
       },
       {
@@ -377,11 +381,11 @@ module.exports = {
         values: ["only"],
         multiple: false,
         description: "Enables Hot Module Replacement.",
+        negatedDescription: "Disables Hot Module Replacement.",
         path: "hot",
       },
     ],
     description: "Enables Hot Module Replacement.",
-    negatedDescription: "Disables Hot Module Replacement.",
     simpleType: "string",
     multiple: false,
   },
@@ -392,12 +396,12 @@ module.exports = {
         multiple: false,
         description:
           "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
+        negatedDescription: "Does not serve over HTTP/2 using SPDY.",
         path: "http2",
       },
     ],
     description:
       "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
-    negatedDescription: "Does not serve over HTTP/2 using SPDY.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -408,13 +412,13 @@ module.exports = {
         multiple: false,
         description:
           "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.",
+        negatedDescription:
+          "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).",
         path: "https",
       },
     ],
     description:
       "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.",
-    negatedDescription:
-      "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).",
     simpleType: "boolean",
     multiple: false,
   },
@@ -620,12 +624,12 @@ module.exports = {
         multiple: false,
         description:
           "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
+        negatedDescription: "Does not request for an SSL certificate.",
         path: "https.requestCert",
       },
     ],
     description:
       "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
-    negatedDescription: "Does not request for an SSL certificate.",
     simpleType: "boolean",
     multiple: false,
   },
@@ -656,13 +660,13 @@ module.exports = {
         multiple: false,
         description:
           "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
+        negatedDescription:
+          "Disables reload/refresh the page(s) when file changes are detected (enabled by default).",
         path: "liveReload",
       },
     ],
     description:
       "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
-    negatedDescription:
-      "Disables reload/refresh the page(s) when file changes are detected (enabled by default)",
     simpleType: "boolean",
     multiple: false,
   },
@@ -673,13 +677,13 @@ module.exports = {
         multiple: false,
         description:
           "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
+        negatedDescription:
+          "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
         path: "magicHtml",
       },
     ],
     description:
       "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
-    negatedDescription:
-      "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
     simpleType: "boolean",
     multiple: false,
   },
@@ -697,12 +701,12 @@ module.exports = {
         multiple: false,
         description:
           "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).",
+        negatedDescription: "Does not open the default browser.",
         path: "open",
       },
     ],
     description:
       "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).",
-    negatedDescription: "Does not open the default browser.",
     simpleType: "string",
     multiple: true,
   },
@@ -786,7 +790,6 @@ module.exports = {
       },
     ],
     description: "Opens specified page in browser.",
-    negatedDescription: "Does not open specified page in browser.",
     simpleType: "string",
     multiple: true,
   },
@@ -1140,12 +1143,12 @@ module.exports = {
         multiple: true,
         description:
           "Tells dev server to use serveIndex middleware when enabled.",
+        negatedDescription:
+          "Does not tell dev server to use serveIndex middleware.",
         path: "static[].serveIndex",
       },
     ],
     description: "Tells dev server to use serveIndex middleware when enabled.",
-    negatedDescription:
-      "Does not tell dev server to use serveIndex middleware.",
     simpleType: "boolean",
     multiple: true,
   },
@@ -1155,11 +1158,12 @@ module.exports = {
         type: "boolean",
         multiple: true,
         description: "Watches for files in static content directory.",
+        negatedDescription:
+          "Does not watch for files in static content directory.",
         path: "static[].watch",
       },
     ],
     description: "Watches for files in static content directory.",
-    negatedDescription: "Does not watch for files in static content directory.",
     simpleType: "boolean",
     multiple: true,
   },

package/lib/Server.js

@@ -25,6 +25,7 @@ const schema = require("./options.json");
 /** @typedef {import("express").NextFunction} NextFunction */
 /** @typedef {import("express").RequestHandler} ExpressRequestHandler */
 /** @typedef {import("express").ErrorRequestHandler} ExpressErrorRequestHandler */
+/** @typedef {import("anymatch").Matcher} AnymatchMatcher */
 /** @typedef {import("chokidar").WatchOptions} WatchOptions */
 /** @typedef {import("chokidar").FSWatcher} FSWatcher */
 /** @typedef {import("connect-history-api-fallback").Options} ConnectHistoryApiFallbackOptions */
@@ -64,7 +65,7 @@ const schema = require("./options.json");
 /**
  * @typedef {Object} WatchFiles
  * @property {string | string[]} paths
- * @property {WatchOptions & { aggregateTimeout?: number, ignored?: string | RegExp | string[], poll?: number | boolean }} [options]
+ * @property {WatchOptions & { aggregateTimeout?: number, ignored?: AnymatchMatcher | string[], poll?: number | boolean }} [options]
  */
 
 /**
@@ -73,7 +74,7 @@ const schema = require("./options.json");
  * @property {string | string[]} [publicPath]
  * @property {boolean | ServeIndexOptions} [serveIndex]
  * @property {ServeStaticOptions} [staticOptions]
- * @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: string | RegExp | string[], poll?: number | boolean }} [watch]
+ * @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: AnymatchMatcher | string[], poll?: number | boolean }} [watch]
  */
 
 /**
@@ -110,22 +111,22 @@ const schema = require("./options.json");
  */
 
 /**
- * @typedef {{ [url: string]: string | HttpProxyMiddlewareOptions }} ProxyConfigMap
+ * @callback ByPass
+ * @param {Request} req
+ * @param {Response} res
+ * @param {ProxyConfigArrayItem} proxyConfig
  */
 
 /**
- * @typedef {HttpProxyMiddlewareOptions[]} ProxyArray
+ * @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
  */
 
 /**
- * @callback ByPass
- * @param {Request} req
- * @param {Response} res
- * @param {ProxyConfigArray} proxyConfig
+ * @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
  */
 
 /**
- * @typedef {{ path?: string | string[] | undefined, context?: string | string[] | HttpProxyMiddlewareOptionsFilter | undefined } & HttpProxyMiddlewareOptions & ByPass} ProxyConfigArray
+ * @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
  */
 
 /**
@@ -194,7 +195,7 @@ const schema = require("./options.json");
  * @property {boolean} [http2]
  * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
  * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
- * @property {ProxyConfigMap | ProxyConfigArray | ProxyArray} [proxy]
+ * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
  * @property {boolean | string | Open | Array<string | Open>} [open]
  * @property {boolean} [setupExitSignals]
  * @property {boolean | ClientConfiguration} [client]
@@ -754,7 +755,7 @@ class Server {
     // TODO remove `{}` after drop webpack v4 support
     const compilerWatchOptions = compilerOptions.watchOptions || {};
     /**
-     * @param {WatchOptions & WebpackConfiguration["watchOptions"]} watchOptions
+     * @param {WatchOptions & { aggregateTimeout?: number, ignored?: AnymatchMatcher | string[], poll?: number | boolean }} watchOptions
      * @returns {WatchOptions}
      */
     const getWatchOptions = (watchOptions = {}) => {
@@ -1380,10 +1381,10 @@ class Server {
           Object.prototype.hasOwnProperty.call(options.proxy, "target") ||
           Object.prototype.hasOwnProperty.call(options.proxy, "router")
         ) {
-          /** @type {ProxyArray} */
+          /** @type {ProxyConfigArray} */
           (options.proxy) = [/** @type {ProxyConfigMap} */ (options.proxy)];
         } else {
-          /** @type {ProxyArray} */
+          /** @type {ProxyConfigArray} */
           (options.proxy) = Object.keys(options.proxy).map(
             /**
              * @param {string} context
@@ -1421,50 +1422,48 @@ class Server {
         }
       }
 
-      /** @type {ProxyArray} */
+      /** @type {ProxyConfigArray} */
       (options.proxy) =
-        /** @type {ProxyArray} */
-        (options.proxy).map(
+        /** @type {ProxyConfigArray} */
+        (options.proxy).map((item) => {
+          if (typeof item === "function") {
+            return item;
+          }
+
           /**
-           * @param {HttpProxyMiddlewareOptions} item
-           * @returns {HttpProxyMiddlewareOptions}
+           * @param {"info" | "warn" | "error" | "debug" | "silent" | undefined | "none" | "log" | "verbose"} level
+           * @returns {"info" | "warn" | "error" | "debug" | "silent" | undefined}
            */
-          (item) => {
-            /**
-             * @param {"info" | "warn" | "error" | "debug" | "silent" | undefined | "none" | "log" | "verbose"} level
-             * @returns {"info" | "warn" | "error" | "debug" | "silent" | undefined}
-             */
-            const getLogLevelForProxy = (level) => {
-              if (level === "none") {
-                return "silent";
-              }
-
-              if (level === "log") {
-                return "info";
-              }
-
-              if (level === "verbose") {
-                return "debug";
-              }
-
-              return level;
-            };
+          const getLogLevelForProxy = (level) => {
+            if (level === "none") {
+              return "silent";
+            }
 
-            if (typeof item.logLevel === "undefined") {
-              item.logLevel = getLogLevelForProxy(
-                compilerOptions.infrastructureLogging
-                  ? compilerOptions.infrastructureLogging.level
-                  : "info"
-              );
+            if (level === "log") {
+              return "info";
             }
 
-            if (typeof item.logProvider === "undefined") {
-              item.logProvider = () => this.logger;
+            if (level === "verbose") {
+              return "debug";
             }
 
-            return item;
+            return level;
+          };
+
+          if (typeof item.logLevel === "undefined") {
+            item.logLevel = getLogLevelForProxy(
+              compilerOptions.infrastructureLogging
+                ? compilerOptions.infrastructureLogging.level
+                : "info"
+            );
           }
-        );
+
+          if (typeof item.logProvider === "undefined") {
+            item.logProvider = () => this.logger;
+          }
+
+          return item;
+        });
     }
 
     if (typeof options.setupExitSignals === "undefined") {
@@ -2124,7 +2123,7 @@ class Server {
       const { createProxyMiddleware } = require("http-proxy-middleware");
 
       /**
-       * @param {ProxyConfigArray} proxyConfig
+       * @param {ProxyConfigArrayItem} proxyConfig
        * @returns {RequestHandler | undefined}
        */
       const getProxyMiddleware = (proxyConfig) => {
@@ -2160,93 +2159,91 @@ class Server {
        *   }
        * ]
        */
-      /** @type {ProxyArray} */
-      (this.options.proxy).forEach(
+      /** @type {ProxyConfigArray} */
+      (this.options.proxy).forEach((proxyConfigOrCallback) => {
         /**
-         * @param {any} proxyConfigOrCallback
+         * @type {RequestHandler}
          */
-        (proxyConfigOrCallback) => {
-          /**
-           * @type {RequestHandler}
-           */
-          let proxyMiddleware;
+        let proxyMiddleware;
 
-          let proxyConfig =
-            typeof proxyConfigOrCallback === "function"
-              ? proxyConfigOrCallback()
-              : proxyConfigOrCallback;
+        let proxyConfig =
+          typeof proxyConfigOrCallback === "function"
+            ? proxyConfigOrCallback()
+            : proxyConfigOrCallback;
 
-          proxyMiddleware =
-            /** @type {RequestHandler} */
-            (getProxyMiddleware(proxyConfig));
+        proxyMiddleware =
+          /** @type {RequestHandler} */
+          (getProxyMiddleware(proxyConfig));
 
-          if (proxyConfig.ws) {
-            this.webSocketProxies.push(proxyMiddleware);
-          }
+        if (proxyConfig.ws) {
+          this.webSocketProxies.push(proxyMiddleware);
+        }
 
-          /**
-           * @param {Request} req
-           * @param {Response} res
-           * @param {NextFunction} next
-           * @returns {Promise<void>}
-           */
-          const handler = async (req, res, next) => {
-            if (typeof proxyConfigOrCallback === "function") {
-              const newProxyConfig = proxyConfigOrCallback(req, res, next);
-
-              if (newProxyConfig !== proxyConfig) {
-                proxyConfig = newProxyConfig;
-                proxyMiddleware =
-                  /** @type {RequestHandler} */
-                  (getProxyMiddleware(proxyConfig));
-              }
+        /**
+         * @param {Request} req
+         * @param {Response} res
+         * @param {NextFunction} next
+         * @returns {Promise<void>}
+         */
+        const handler = async (req, res, next) => {
+          if (typeof proxyConfigOrCallback === "function") {
+            const newProxyConfig = proxyConfigOrCallback(req, res, next);
+
+            if (newProxyConfig !== proxyConfig) {
+              proxyConfig = newProxyConfig;
+              proxyMiddleware =
+                /** @type {RequestHandler} */
+                (getProxyMiddleware(proxyConfig));
             }
+          }
 
-            // - Check if we have a bypass function defined
-            // - In case the bypass function is defined we'll retrieve the
-            // bypassUrl from it otherwise bypassUrl would be null
-            // TODO remove in the next major in favor `context` and `router` options
-            const isByPassFuncDefined =
-              typeof proxyConfig.bypass === "function";
-            const bypassUrl = isByPassFuncDefined
-              ? await proxyConfig.bypass(req, res, proxyConfig)
-              : null;
-
-            if (typeof bypassUrl === "boolean") {
-              // skip the proxy
-              // @ts-ignore
-              req.url = null;
-              next();
-            } else if (typeof bypassUrl === "string") {
-              // byPass to that url
-              req.url = bypassUrl;
-              next();
-            } else if (proxyMiddleware) {
-              return proxyMiddleware(req, res, next);
-            } else {
-              next();
-            }
-          };
+          // - Check if we have a bypass function defined
+          // - In case the bypass function is defined we'll retrieve the
+          // bypassUrl from it otherwise bypassUrl would be null
+          // TODO remove in the next major in favor `context` and `router` options
+          const isByPassFuncDefined = typeof proxyConfig.bypass === "function";
+          const bypassUrl = isByPassFuncDefined
+            ? await /** @type {ByPass} */ (proxyConfig.bypass)(
+                req,
+                res,
+                proxyConfig
+              )
+            : null;
+
+          if (typeof bypassUrl === "boolean") {
+            // skip the proxy
+            // @ts-ignore
+            req.url = null;
+            next();
+          } else if (typeof bypassUrl === "string") {
+            // byPass to that url
+            req.url = bypassUrl;
+            next();
+          } else if (proxyMiddleware) {
+            return proxyMiddleware(req, res, next);
+          } else {
+            next();
+          }
+        };
 
-          middlewares.push({
-            name: "http-proxy-middleware",
-            middleware: handler,
-          });
-          // Also forward error requests to the proxy so it can handle them.
-          middlewares.push({
-            name: "http-proxy-middleware-error-handler",
-            middleware:
-              /**
-               * @param {Error} error
-               * @param {Request} req
-               * @param {Response} res
-               * @param {NextFunction} next
-               * @returns {any}
-               */
-              (error, req, res, next) => handler(req, res, next),
-          });
-        }
-      );
+        middlewares.push({
+          name: "http-proxy-middleware",
+          middleware: handler,
+        });
+        // Also forward error requests to the proxy so it can handle them.
+        middlewares.push({
+          name: "http-proxy-middleware-error-handler",
+          middleware:
+            /**
+             * @param {Error} error
+             * @param {Request} req
+             * @param {Response} res
+             * @param {NextFunction} next
+             * @returns {any}
+             */
+            (error, req, res, next) => handler(req, res, next),
+        });
+      });
 
       middlewares.push({
         name: "webpack-dev-middleware",