webpack-dev-server 4.7.0 → 4.7.4

package/client/utils/reloadApp.js

@@ -1,6 +1,12 @@
-/* global __webpack_hash__ */
 import hotEmitter from "webpack/hot/emitter.js";
 import { log } from "./log.js";
+/** @typedef {import("../index").Options} Options
+/** @typedef {import("../index").Status} Status
+
+/**
+ * @param {Options} options
+ * @param {Status} status
+ */
 
 function reloadApp(_ref, status) {
   var hot = _ref.hot,
@@ -12,11 +18,18 @@ function reloadApp(_ref, status) {
 
   var currentHash = status.currentHash,
       previousHash = status.previousHash;
-  var isInitial = currentHash.indexOf(previousHash) >= 0;
+  var isInitial = currentHash.indexOf(
+  /** @type {string} */
+  previousHash) >= 0;
 
   if (isInitial) {
     return;
   }
+  /**
+   * @param {Window} rootWindow
+   * @param {number} intervalId
+   */
+
 
   function applyReload(rootWindow, intervalId) {
     clearInterval(intervalId);

package/client/utils/sendMessage.js

@@ -3,7 +3,7 @@
 
 /**
  * @param {string} type
- * @param {any} data
+ * @param {any} [data]
  */
 function sendMsg(type, data) {
   if (typeof self !== "undefined" && (typeof WorkerGlobalScope === "undefined" || !(self instanceof WorkerGlobalScope))) {

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") {
@@ -1478,13 +1477,7 @@ class Server {
     } else if (typeof options.static === "string") {
       options.static = [getStaticItem(options.static)];
     } else if (Array.isArray(options.static)) {
-      options.static = options.static.map((item) => {
-        if (typeof item === "string") {
-          return getStaticItem(item);
-        }
-
-        return getStaticItem(item);
-      });
+      options.static = options.static.map((item) => getStaticItem(item));
     } else {
       options.static = [getStaticItem(options.static)];
     }
@@ -2130,7 +2123,7 @@ class Server {
       const { createProxyMiddleware } = require("http-proxy-middleware");
 
       /**
-       * @param {ProxyConfigArray} proxyConfig
+       * @param {ProxyConfigArrayItem} proxyConfig
        * @returns {RequestHandler | undefined}
        */
       const getProxyMiddleware = (proxyConfig) => {
@@ -2166,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",
@@ -2375,10 +2366,6 @@ class Server {
       });
     }
 
-    if (typeof this.options.onAfterSetupMiddleware === "function") {
-      this.options.onAfterSetupMiddleware(this);
-    }
-
     if (typeof this.options.setupMiddlewares === "function") {
       middlewares = this.options.setupMiddlewares(middlewares, this);
     }
@@ -2395,6 +2382,10 @@ class Server {
         (this.app).use(middleware.middleware);
       }
     });
+
+    if (typeof this.options.onAfterSetupMiddleware === "function") {
+      this.options.onAfterSetupMiddleware(this);
+    }
   }
 
   /**

package/lib/options.json

@@ -37,7 +37,10 @@
         }
       ],
       "description": "Allows to broadcasts dev server via ZeroConf networking on start.",
-      "link": " https://webpack.js.org/configuration/dev-server/#devserverbonjour"
+      "link": " https://webpack.js.org/configuration/dev-server/#devserverbonjour",
+      "cli": {
+        "negatedDescription": "Disallows to broadcasts dev server via ZeroConf networking on start."
+      }
     },
     "Client": {
       "description": "Allows to specify options for client script in the browser or disable client script.",
@@ -82,7 +85,10 @@
         {
           "description": "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
           "link": "https://webpack.js.org/configuration/dev-server/#overlay",
-          "type": "boolean"
+          "type": "boolean",
+          "cli": {
+            "negatedDescription": "Disables a full-screen overlay in the browser when there are compiler errors or warnings."
+          }
         },
         {
           "type": "object",
@@ -103,7 +109,10 @@
     "ClientProgress": {
       "description": "Prints compilation progress in percentage in the browser.",
       "link": "https://webpack.js.org/configuration/dev-server/#progress",
-      "type": "boolean"
+      "type": "boolean",
+      "cli": {
+        "negatedDescription": "Does not print compilation progress in percentage in the browser."
+      }
     },
     "ClientReconnect": {
       "description": "Tells dev-server the number of times it should try to reconnect the client.",
@@ -116,7 +125,10 @@
           "type": "number",
           "minimum": 0
         }
-      ]
+      ],
+      "cli": {
+        "negatedDescription": "Tells dev-server to not to try to connect the client."
+      }
     },
     "ClientWebSocketTransport": {
       "anyOf": [
@@ -197,7 +209,10 @@
     "Compress": {
       "type": "boolean",
       "description": "Enables gzip compression for everything served.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devservercompress"
+      "link": "https://webpack.js.org/configuration/dev-server/#devservercompress",
+      "cli": {
+        "negatedDescription": "Disables gzip compression for everything served."
+      }
     },
     "DevMiddleware": {
       "description": "Provide options to 'webpack-dev-middleware' which handles webpack assets.",
@@ -208,12 +223,18 @@
     "HTTP2": {
       "type": "boolean",
       "description": "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2"
+      "link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2",
+      "cli": {
+        "negatedDescription": "Does not serve over HTTP/2 using SPDY."
+      }
     },
     "HTTPS": {
       "anyOf": [
         {
-          "type": "boolean"
+          "type": "boolean",
+          "cli": {
+            "negatedDescription": "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP)."
+          }
         },
         {
           "type": "object",
@@ -225,7 +246,10 @@
             },
             "requestCert": {
               "type": "boolean",
-              "description": "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option."
+              "description": "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
+              "cli": {
+                "negatedDescription": "Does not request for an SSL certificate."
+              }
             },
             "ca": {
               "anyOf": [
@@ -458,7 +482,10 @@
         }
       ],
       "description": "Enables Hot Module Replacement.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserverhot"
+      "link": "https://webpack.js.org/configuration/dev-server/#devserverhot",
+      "cli": {
+        "negatedDescription": "Disables Hot Module Replacement."
+      }
     },
     "IPC": {
       "anyOf": [
@@ -477,11 +504,17 @@
     "LiveReload": {
       "type": "boolean",
       "description": "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
+      "cli": {
+        "negatedDescription": "Disables reload/refresh the page(s) when file changes are detected (enabled by default)."
+      },
       "link": "https://webpack.js.org/configuration/dev-server/#devserverlivereload"
     },
     "MagicHTML": {
       "type": "boolean",
       "description": "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
+      "cli": {
+        "negatedDescription": "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js')."
+      },
       "link": "https://webpack.js.org/configuration/dev-server/#devservermagichtml"
     },
     "OnAfterSetupMiddleware": {
@@ -528,7 +561,10 @@
       "link": "https://webpack.js.org/configuration/dev-server/#devserveropen"
     },
     "OpenBoolean": {
-      "type": "boolean"
+      "type": "boolean",
+      "cli": {
+        "negatedDescription": "Does not open the default browser."
+      }
     },
     "OpenObject": {
       "type": "object",
@@ -581,7 +617,10 @@
             {
               "type": "string",
               "minLength": 1,
-              "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+              "description": "Open specified browser.",
+              "cli": {
+                "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+              }
             }
           ],
           "description": "Open specified browser."
@@ -931,6 +970,9 @@
             }
           ],
           "description": "Tells dev server to use serveIndex middleware when enabled.",
+          "cli": {
+            "negatedDescription": "Does not tell dev server to use serveIndex middleware."
+          },
           "link": "https://webpack.js.org/configuration/dev-server/#serveindex"
         },
         "watch": {
@@ -945,6 +987,9 @@
             }
           ],
           "description": "Watches for files in static content directory.",
+          "cli": {
+            "negatedDescription": "Does not watch for files in static content directory."
+          },
           "link": "https://webpack.js.org/configuration/dev-server/#watch"
         }
       }
@@ -1043,7 +1088,9 @@
           "$ref": "#/definitions/WebSocketServerType"
         }
       ],
-      "description": "Deprecated: please use '--web-socket-server-type' option."
+      "cli": {
+        "description": "Deprecated: please use '--web-socket-server-type' option."
+      }
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"