webpack-dev-server 4.7.0 → 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/client/clients/SockJSClient.js

@@ -52,7 +52,11 @@ var SockJSClient = /*#__PURE__*/function () {
   }, {
     key: "onMessage",
     value: function onMessage(f) {
-      this.sock.onmessage = function (e) {
+      this.sock.onmessage =
+      /**
+       * @param {Error & { data: string }} e
+       */
+      function (e) {
         f(e.data);
       };
     }

package/client/index.js

@@ -1,4 +1,5 @@
 /* global __resourceQuery, __webpack_hash__ */
+/// <reference types="webpack/module" />
 import webpackHotLog from "webpack/hot/log.js";
 import stripAnsi from "./modules/strip-ansi/index.js";
 import parseURL from "./utils/parseURL.js";
@@ -8,12 +9,35 @@ import { log, setLogLevel } from "./utils/log.js";
 import sendMessage from "./utils/sendMessage.js";
 import reloadApp from "./utils/reloadApp.js";
 import createSocketURL from "./utils/createSocketURL.js";
+/**
+ * @typedef {Object} Options
+ * @property {boolean} hot
+ * @property {boolean} liveReload
+ * @property {boolean} progress
+ * @property {boolean | { warnings?: boolean, errors?: boolean }} overlay
+ * @property {string} [logging]
+ * @property {number} [reconnect]
+ */
+
+/**
+ * @typedef {Object} Status
+ * @property {boolean} isUnloading
+ * @property {string} currentHash
+ * @property {string} [previousHash]
+ */
+
+/**
+ * @type {Status}
+ */
+
 var status = {
   isUnloading: false,
   // TODO Workaround for webpack v4, `__webpack_hash__` is not replaced without HotModuleReplacement
   // eslint-disable-next-line camelcase
   currentHash: typeof __webpack_hash__ !== "undefined" ? __webpack_hash__ : ""
 };
+/** @type {Options} */
+
 var options = {
   hot: false,
   liveReload: false,
@@ -92,6 +116,10 @@ var onSocketMessage = {
     status.currentHash = _hash;
   },
   logging: setAllLogLevel,
+
+  /**
+   * @param {boolean} value
+   */
   overlay: function overlay(value) {
     if (typeof document === "undefined") {
       return;
@@ -99,6 +127,10 @@ var onSocketMessage = {
 
     options.overlay = value;
   },
+
+  /**
+   * @param {number} value
+   */
   reconnect: function reconnect(value) {
     if (parsedResourceQuery.reconnect === "false") {
       return;
@@ -106,9 +138,17 @@ var onSocketMessage = {
 
     options.reconnect = value;
   },
-  progress: function progress(_progress) {
-    options.progress = _progress;
+
+  /**
+   * @param {boolean} value
+   */
+  progress: function progress(value) {
+    options.progress = value;
   },
+
+  /**
+   * @param {{ pluginName?: string, percent: number, msg: string }} data
+   */
   "progress-update": function progressUpdate(data) {
     if (options.progress) {
       log.info("".concat(data.pluginName ? "[".concat(data.pluginName, "] ") : "").concat(data.percent, "% - ").concat(data.msg, "."));
@@ -135,10 +175,18 @@ var onSocketMessage = {
     reloadApp(options, status);
   },
   // TODO: remove in v5 in favor of 'static-changed'
+
+  /**
+   * @param {string} file
+   */
   "content-changed": function contentChanged(file) {
     log.info("".concat(file ? "\"".concat(file, "\"") : "Content", " from static directory was changed. Reloading..."));
     self.location.reload();
   },
+
+  /**
+   * @param {string} file
+   */
   "static-changed": function staticChanged(file) {
     log.info("".concat(file ? "\"".concat(file, "\"") : "Content", " from static directory was changed. Reloading..."));
     self.location.reload();

package/client/modules/sockjs-client/index.js

@@ -6459,7 +6459,7 @@ function Url(address, location, parser) {
 
   if (url.auth) {
     instruction = url.auth.split(':');
-    url.username = instruction[0] || '';
+    url.username = instruction[0];
     url.password = instruction[1] || '';
   }
 
@@ -6544,8 +6544,15 @@ function set(part, value, fn) {
 
       break;
 
-    default:
-      url[part] = value;
+    case 'username':
+    case 'password':
+      url[part] = encodeURIComponent(value);
+      break;
+
+    case 'auth':
+      var splits = value.split(':');
+      url.username = splits[0];
+      url.password = splits.length === 2 ? splits[1] : '';
   }
 
   for (var i = 0; i < rules.length; i++) {
@@ -6553,6 +6560,7 @@ function set(part, value, fn) {
     if (ins[4]) url[ins[1]] = url[ins[1]].toLowerCase();
   }
 
+  url.auth = url.password ? url.username + ':' + url.password : url.username;
   url.origin = url.protocol !== 'file:' && isSpecial(url.protocol) && url.host ? url.protocol + '//' + url.host : 'null';
   url.href = url.toString();
   return url;
@@ -6572,12 +6580,15 @@ function toString(stringify) {
       url = this,
       protocol = url.protocol;
   if (protocol && protocol.charAt(protocol.length - 1) !== ':') protocol += ':';
-  var result = protocol + (url.slashes || isSpecial(url.protocol) ? '//' : '');
+  var result = protocol + (url.protocol && url.slashes || isSpecial(url.protocol) ? '//' : '');
 
   if (url.username) {
     result += url.username;
     if (url.password) result += ':' + url.password;
     result += '@';
+  } else if (url.password) {
+    result += ':' + url.password;
+    result += '@';
   }
 
   result += url.host + url.pathname;

package/client/overlay.js

@@ -14,8 +14,14 @@ var colors = {
   lightgrey: "EBE7E3",
   darkgrey: "6D7891"
 };
+/** @type {HTMLIFrameElement | null | undefined} */
+
 var iframeContainerElement;
+/** @type {HTMLDivElement | null | undefined} */
+
 var containerElement;
+/** @type {Array<(element: HTMLDivElement) => void>} */
+
 var onLoadQueue = [];
 ansiHTML.setColors(colors);
 
@@ -34,7 +40,11 @@ function createContainer() {
   iframeContainerElement.style.zIndex = 9999999999;
 
   iframeContainerElement.onload = function () {
-    containerElement = iframeContainerElement.contentDocument.createElement("div");
+    containerElement =
+    /** @type {Document} */
+
+    /** @type {HTMLIFrameElement} */
+    iframeContainerElement.contentDocument.createElement("div");
     containerElement.id = "webpack-dev-server-client-overlay-div";
     containerElement.style.position = "fixed";
     containerElement.style.boxSizing = "border-box";
@@ -62,7 +72,8 @@ function createContainer() {
     closeButtonElement.style.fontWeight = "bold";
     closeButtonElement.style.color = "white";
     closeButtonElement.style.cursor = "pointer";
-    closeButtonElement.style.cssFloat = "right";
+    closeButtonElement.style.cssFloat = "right"; // @ts-ignore
+
     closeButtonElement.style.styleFloat = "right";
     closeButtonElement.addEventListener("click", function () {
       hide();
@@ -71,16 +82,27 @@ function createContainer() {
     containerElement.appendChild(closeButtonElement);
     containerElement.appendChild(document.createElement("br"));
     containerElement.appendChild(document.createElement("br"));
+    /** @type {Document} */
+
+    /** @type {HTMLIFrameElement} */
     iframeContainerElement.contentDocument.body.appendChild(containerElement);
     onLoadQueue.forEach(function (onLoad) {
-      onLoad(containerElement);
+      onLoad(
+      /** @type {HTMLDivElement} */
+      containerElement);
     });
     onLoadQueue = [];
+    /** @type {HTMLIFrameElement} */
+
     iframeContainerElement.onload = null;
   };
 
   document.body.appendChild(iframeContainerElement);
 }
+/**
+ * @param {(element: HTMLDivElement) => void} callback
+ */
+
 
 function ensureOverlayExists(callback) {
   if (containerElement) {
@@ -109,6 +131,12 @@ function hide() {
   iframeContainerElement = null;
   containerElement = null;
 }
+/**
+ * @param {string} type
+ * @param {string  | { file?: string, moduleName?: string, loc?: string, message?: string }} item
+ * @returns {{ header: string, body: string }}
+ */
+
 
 function formatProblem(type, item) {
   var header = type === "warning" ? "WARNING" : "ERROR";
@@ -131,6 +159,11 @@ function formatProblem(type, item) {
   };
 } // Compilation with errors (e.g. syntax error or missing modules).
 
+/**
+ * @param {string} type
+ * @param {Array<string  | { file?: string, moduleName?: string, loc?: string, message?: string }>} messages
+ */
+
 
 function show(type, messages) {
   ensureOverlayExists(function () {
@@ -154,6 +187,8 @@ function show(type, messages) {
       entryElement.appendChild(messageTextNode);
       entryElement.appendChild(document.createElement("br"));
       entryElement.appendChild(document.createElement("br"));
+      /** @type {HTMLDivElement} */
+
       containerElement.appendChild(entryElement);
     });
   });

package/client/socket.js

@@ -11,12 +11,20 @@ typeof __webpack_dev_server_client__ !== "undefined" ? typeof __webpack_dev_serv
 var retries = 0;
 var maxRetries = 10;
 var client = null;
+/**
+ * @param {string} url
+ * @param {{ [handler: string]: (data?: any, params?: any) => any }} handlers
+ * @param {number} [reconnect]
+ */
 
 var socket = function initSocket(url, handlers, reconnect) {
   client = new Client(url);
   client.onOpen(function () {
     retries = 0;
-    maxRetries = reconnect;
+
+    if (typeof reconnect !== "undefined") {
+      maxRetries = reconnect;
+    }
   });
   client.onClose(function () {
     if (retries === 0) {
@@ -38,7 +46,11 @@ var socket = function initSocket(url, handlers, reconnect) {
       }, retryInMs);
     }
   });
-  client.onMessage(function (data) {
+  client.onMessage(
+  /**
+   * @param {any} data
+   */
+  function (data) {
     var message = JSON.parse(data);
 
     if (handlers[message.type]) {

package/client/utils/createSocketURL.js

@@ -1,9 +1,76 @@
-import url from "url"; // We handle legacy API that is Node.js specific, and a newer API that implements the same WHATWG URL Standard used by web browsers
-// Please look at https://nodejs.org/api/url.html#url_url_strings_and_url_objects
+/**
+ * @param {{ protocol?: string, auth?: string, hostname?: string, port?: string, pathname?: string, search?: string, hash?: string, slashes?: boolean }} objURL
+ * @returns {string}
+ */
+function format(objURL) {
+  var protocol = objURL.protocol || "";
+
+  if (protocol && protocol.substr(-1) !== ":") {
+    protocol += ":";
+  }
+
+  var auth = objURL.auth || "";
+
+  if (auth) {
+    auth = encodeURIComponent(auth);
+    auth = auth.replace(/%3A/i, ":");
+    auth += "@";
+  }
+
+  var host = "";
+
+  if (objURL.hostname) {
+    host = auth + (objURL.hostname.indexOf(":") === -1 ? objURL.hostname : "[".concat(objURL.hostname, "]"));
+
+    if (objURL.port) {
+      host += ":".concat(objURL.port);
+    }
+  }
+
+  var pathname = objURL.pathname || "";
+
+  if (objURL.slashes) {
+    host = "//".concat(host || "");
+
+    if (pathname && pathname.charAt(0) !== "/") {
+      pathname = "/".concat(pathname);
+    }
+  } else if (!host) {
+    host = "";
+  }
+
+  var search = objURL.search || "";
+
+  if (search && search.charAt(0) !== "?") {
+    search = "?".concat(search);
+  }
+
+  var hash = objURL.hash || "";
+
+  if (hash && hash.charAt(0) !== "#") {
+    hash = "#".concat(hash);
+  }
+
+  pathname = pathname.replace(/[?#]/g,
+  /**
+   * @param {string} match
+   * @returns {string}
+   */
+  function (match) {
+    return encodeURIComponent(match);
+  });
+  search = search.replace("#", "%23");
+  return "".concat(protocol).concat(host).concat(pathname).concat(search).concat(hash);
+}
+/**
+ * @param {URL & { fromCurrentScript?: boolean }} parsedURL
+ * @returns {string}
+ */
+
 
 function createSocketURL(parsedURL) {
   var hostname = parsedURL.hostname; // Node.js module parses it as `::`
-  // `new URL(urlString, [baseURLstring])` parses it as '[::]'
+  // `new URL(urlString, [baseURLString])` parses it as '[::]'
 
   var isInAddrAny = hostname === "0.0.0.0" || hostname === "::" || hostname === "[::]"; // why do we need this check?
   // hostname n/a for file protocol (example, when using electron, ionic)
@@ -57,7 +124,7 @@ function createSocketURL(parsedURL) {
     socketURLPathname = parsedURL.pathname;
   }
 
-  return url.format({
+  return format({
     protocol: socketURLProtocol,
     auth: socketURLAuth,
     hostname: socketURLHostname,

package/client/utils/getCurrentScriptSource.js

@@ -1,3 +1,6 @@
+/**
+ * @returns {string}
+ */
 function getCurrentScriptSource() {
   // `document.currentScript` is the most accurate way to find the current script,
   // but is not supported in all browsers.

package/client/utils/parseURL.js

@@ -1,7 +1,11 @@
-import url from "url";
 import getCurrentScriptSource from "./getCurrentScriptSource.js";
+/**
+ * @param {string} resourceQuery
+ * @returns {{ [key: string]: string | boolean }}
+ */
 
 function parseURL(resourceQuery) {
+  /** @type {{ [key: string]: string }} */
   var options = {};
 
   if (typeof resourceQuery === "string" && resourceQuery !== "") {
@@ -14,25 +18,19 @@ function parseURL(resourceQuery) {
   } else {
     // Else, get the url from the <script> this file was called with.
     var scriptSource = getCurrentScriptSource();
+    var scriptSourceURL;
+
+    try {
+      // The placeholder `baseURL` with `window.location.href`,
+      // is to allow parsing of path-relative or protocol-relative URLs,
+      // and will have no effect if `scriptSource` is a fully valid URL.
+      scriptSourceURL = new URL(scriptSource, self.location.href);
+    } catch (error) {// URL parsing failed, do nothing.
+      // We will still proceed to see if we can recover using `resourceQuery`
+    }
 
-    if (scriptSource) {
-      var scriptSourceURL;
-
-      try {
-        // The placeholder `baseURL` with `window.location.href`,
-        // is to allow parsing of path-relative or protocol-relative URLs,
-        // and will have no effect if `scriptSource` is a fully valid URL.
-        scriptSourceURL = new URL(scriptSource, self.location.href);
-      } catch (error) {// URL parsing failed, do nothing.
-        // We will still proceed to see if we can recover using `resourceQuery`
-      }
-
-      if (scriptSourceURL) {
-        options = scriptSourceURL;
-        options.fromCurrentScript = true;
-      }
-    } else {
-      options = url.parse(self.location.href, true, true);
+    if (scriptSourceURL) {
+      options = scriptSourceURL;
       options.fromCurrentScript = true;
     }
   }