webpack-dev-server 4.3.1 → 4.7.0

package/lib/options.json

@@ -59,6 +59,9 @@
             "progress": {
               "$ref": "#/definitions/ClientProgress"
             },
+            "reconnect": {
+              "$ref": "#/definitions/ClientReconnect"
+            },
             "webSocketTransport": {
               "$ref": "#/definitions/ClientWebSocketTransport"
             },
@@ -71,7 +74,7 @@
     },
     "ClientLogging": {
       "enum": ["none", "error", "warn", "info", "log", "verbose"],
-      "decription": "Allows to set log level in the browser.",
+      "description": "Allows to set log level in the browser.",
       "link": "https://webpack.js.org/configuration/dev-server/#logging"
     },
     "ClientOverlay": {
@@ -102,6 +105,19 @@
       "link": "https://webpack.js.org/configuration/dev-server/#progress",
       "type": "boolean"
     },
+    "ClientReconnect": {
+      "description": "Tells dev-server the number of times it should try to reconnect the client.",
+      "link": "https://webpack.js.org/configuration/dev-server/#reconnect",
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "number",
+          "minimum": 0
+        }
+      ]
+    },
     "ClientWebSocketTransport": {
       "anyOf": [
         {
@@ -191,7 +207,7 @@
     },
     "HTTP2": {
       "type": "boolean",
-      "description": "Allows to serve over HTTP/2 using SPDY.",
+      "description": "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2"
     },
     "HTTPS": {
@@ -205,11 +221,11 @@
           "properties": {
             "passphrase": {
               "type": "string",
-              "description": "Passphrase for a pfx file."
+              "description": "Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option."
             },
             "requestCert": {
               "type": "boolean",
-              "description": "Request for an SSL certificate."
+              "description": "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option."
             },
             "ca": {
               "anyOf": [
@@ -233,7 +249,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
+              "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
             },
             "cacert": {
               "anyOf": [
@@ -257,7 +273,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
+              "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
             },
             "cert": {
               "anyOf": [
@@ -281,7 +297,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL certificate or content of an SSL certificate."
+              "description": "Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option."
             },
             "crl": {
               "anyOf": [
@@ -305,7 +321,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists)."
+              "description": "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option."
             },
             "key": {
               "anyOf": [
@@ -333,7 +349,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL key or content of an SSL key."
+              "description": "Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option."
             },
             "pfx": {
               "anyOf": [
@@ -361,12 +377,12 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL pfx file or content of an SSL pfx file."
+              "description": "Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option."
             }
           }
         }
       ],
-      "description": "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).",
+      "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.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverhttps"
     },
     "HeaderObject": {
@@ -470,12 +486,12 @@
     },
     "OnAfterSetupMiddleware": {
       "instanceof": "Function",
-      "description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares.",
+      "description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares. Deprecated: please use the 'setupMiddlewares' option.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserveronaftersetupmiddleware"
     },
     "OnBeforeSetupMiddleware": {
       "instanceof": "Function",
-      "description": "Provides the ability to execute a custom function and apply custom middleware(s) prior to all other middlewares.",
+      "description": "Provides the ability to execute a custom function and apply custom middleware(s) prior to all other middlewares. Deprecated: please use the 'setupMiddlewares' option.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserveronbeforesetupmiddleware"
     },
     "OnListening": {
@@ -564,7 +580,8 @@
             },
             {
               "type": "string",
-              "minLength": 1
+              "minLength": 1,
+              "description": "Open specified browser. Deprecated: please use '--open-app-name'."
             }
           ],
           "description": "Open specified browser."
@@ -615,6 +632,222 @@
       "description": "Allows to proxy requests, can be useful when you have a separate API backend development server and you want to send API requests on the same domain.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverproxy"
     },
+    "Server": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/ServerEnum"
+        },
+        {
+          "$ref": "#/definitions/ServerString"
+        },
+        {
+          "$ref": "#/definitions/ServerObject"
+        }
+      ],
+      "link": "https://webpack.js.org/configuration/dev-server/#devserverserver",
+      "description": "Allows to set server and options (by default 'http')."
+    },
+    "ServerType": {
+      "enum": ["http", "https", "spdy"]
+    },
+    "ServerEnum": {
+      "enum": ["http", "https", "spdy"],
+      "cli": {
+        "exclude": true
+      }
+    },
+    "ServerString": {
+      "type": "string",
+      "minLength": 1,
+      "cli": {
+        "exclude": true
+      }
+    },
+    "ServerObject": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ServerType"
+            },
+            {
+              "$ref": "#/definitions/ServerString"
+            }
+          ]
+        },
+        "options": {
+          "$ref": "#/definitions/ServerOptions"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ServerOptions": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "passphrase": {
+          "type": "string",
+          "description": "Passphrase for a pfx file."
+        },
+        "requestCert": {
+          "type": "boolean",
+          "description": "Request for an SSL certificate."
+        },
+        "ca": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
+        },
+        "cacert": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
+        },
+        "cert": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to an SSL certificate or content of an SSL certificate."
+        },
+        "crl": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists)."
+        },
+        "key": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  },
+                  {
+                    "type": "object",
+                    "additionalProperties": true
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to an SSL key or content of an SSL key."
+        },
+        "pfx": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "instanceof": "Buffer"
+                  },
+                  {
+                    "type": "object",
+                    "additionalProperties": true
+                  }
+                ]
+              }
+            },
+            {
+              "type": "string"
+            },
+            {
+              "instanceof": "Buffer"
+            }
+          ],
+          "description": "Path to an SSL pfx file or content of an SSL pfx file."
+        }
+      }
+    },
     "SetupExitSignals": {
       "type": "boolean",
       "description": "Allows to close dev server and exit the process on SIGINT and SIGTERM signals (enabled by default for CLI).",
@@ -623,6 +856,11 @@
         "exclude": true
       }
     },
+    "SetupMiddlewares": {
+      "instanceof": "Function",
+      "description": "Provides the ability to execute a custom function and apply custom middleware(s).",
+      "link": "https://webpack.js.org/configuration/dev-server/#devserversetupmiddlewares"
+    },
     "Static": {
       "anyOf": [
         {
@@ -759,10 +997,13 @@
               "type": "string",
               "minLength": 1
             }
-          ]
+          ],
+          "description": "Path(s) of globs/directories/files to watch for file changes."
         },
         "options": {
           "type": "object",
+          "description": "Configure advanced options for watching. See the chokidar documentation for the possible options.",
+          "link": "https://github.com/paulmillr/chokidar#api",
           "additionalProperties": true
         }
       },
@@ -790,22 +1031,30 @@
       "description": "Allows to set web socket server and options (by default 'ws').",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
     },
+    "WebSocketServerType": {
+      "enum": ["sockjs", "ws"]
+    },
     "WebSocketServerEnum": {
-      "enum": [false, "sockjs", "ws"]
+      "anyOf": [
+        {
+          "enum": [false]
+        },
+        {
+          "$ref": "#/definitions/WebSocketServerType"
+        }
+      ],
+      "description": "Deprecated: please use '--web-socket-server-type' option."
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"
     },
     "WebSocketServerObject": {
       "type": "object",
-      "cli": {
-        "exclude": true
-      },
       "properties": {
         "type": {
           "anyOf": [
             {
-              "$ref": "#/definitions/WebSocketServerEnum"
+              "$ref": "#/definitions/WebSocketServerType"
             },
             {
               "$ref": "#/definitions/WebSocketServerString"
@@ -817,7 +1066,10 @@
         },
         "options": {
           "type": "object",
-          "additionalProperties": true
+          "additionalProperties": true,
+          "cli": {
+            "exclude": true
+          }
         }
       },
       "additionalProperties": false
@@ -889,9 +1141,15 @@
     "proxy": {
       "$ref": "#/definitions/Proxy"
     },
+    "server": {
+      "$ref": "#/definitions/Server"
+    },
     "setupExitSignals": {
       "$ref": "#/definitions/SetupExitSignals"
     },
+    "setupMiddlewares": {
+      "$ref": "#/definitions/SetupMiddlewares"
+    },
     "static": {
       "$ref": "#/definitions/Static"
     },

package/lib/servers/BaseServer.js

@@ -1,10 +1,18 @@
 "use strict";
 
+/** @typedef {import("../Server").ClientConnection} ClientConnection */
+
 // base class that users should extend if they are making their own
 // server implementation
 module.exports = class BaseServer {
+  /**
+   * @param {import("../Server")} server
+   */
   constructor(server) {
+    /** @type {import("../Server")} */
     this.server = server;
+
+    /** @type {ClientConnection[]} */
     this.clients = [];
   }
 };

package/lib/servers/SockJSServer.js

@@ -1,18 +1,22 @@
 "use strict";
 
-/* eslint-disable
-  class-methods-use-this
-*/
 const sockjs = require("sockjs");
 const BaseServer = require("./BaseServer");
 
+/** @typedef {import("../Server").WebSocketServerConfiguration} WebSocketServerConfiguration */
+/** @typedef {import("../Server").ClientConnection} ClientConnection */
+
 // Workaround for sockjs@~0.3.19
 // sockjs will remove Origin header, however Origin header is required for checking host.
 // See https://github.com/webpack/webpack-dev-server/issues/1604 for more information
 {
+  // @ts-ignore
   const SockjsSession = require("sockjs/lib/transport").Session;
   const decorateConnection = SockjsSession.prototype.decorateConnection;
 
+  /**
+   * @param {import("http").IncomingMessage} req
+   */
   // eslint-disable-next-line func-names
   SockjsSession.prototype.decorateConnection = function (req) {
     decorateConnection.call(this, req);
@@ -31,6 +35,9 @@ const BaseServer = require("./BaseServer");
 
 module.exports = class SockJSServer extends BaseServer {
   // options has: error (function), debug (function), server (http/s server), path (string)
+  /**
+   * @param {import("../Server")} server
+   */
   constructor(server) {
     super(server);
 
@@ -38,6 +45,10 @@ module.exports = class SockJSServer extends BaseServer {
       // Use provided up-to-date sockjs-client
       sockjs_url: "/__webpack_dev_server__/sockjs.bundle.js",
       // Default logger is very annoy. Limit useless logs.
+      /**
+       * @param {string} severity
+       * @param {string} line
+       */
       log: (severity, line) => {
         if (severity === "error") {
           this.server.logger.error(line);
@@ -49,6 +60,10 @@ module.exports = class SockJSServer extends BaseServer {
       },
     });
 
+    /**
+     * @param {import("sockjs").ServerOptions & { path?: string }} options
+     * @returns {string | undefined}
+     */
     const getPrefix = (options) => {
       if (typeof options.prefix !== "undefined") {
         return options.prefix;
@@ -57,23 +72,41 @@ module.exports = class SockJSServer extends BaseServer {
       return options.path;
     };
 
-    this.implementation.installHandlers(this.server.server, {
-      ...this.server.options.webSocketServer.options,
-      prefix: getPrefix(this.server.options.webSocketServer.options),
-    });
+    const options = {
+      .../** @type {WebSocketServerConfiguration} */
+      (this.server.options.webSocketServer).options,
+      prefix: getPrefix(
+        /** @type {NonNullable<WebSocketServerConfiguration["options"]>} */
+        (
+          /** @type {WebSocketServerConfiguration} */
+          (this.server.options.webSocketServer).options
+        )
+      ),
+    };
+
+    this.implementation.installHandlers(
+      /** @type {import("http").Server} */ (this.server.server),
+      options
+    );
 
     this.implementation.on("connection", (client) => {
+      // @ts-ignore
       // Implement the the same API as for `ws`
       client.send = client.write;
+      // @ts-ignore
       client.terminate = client.close;
 
-      this.clients.push(client);
+      this.clients.push(/** @type {ClientConnection} */ (client));
 
       client.on("close", () => {
-        this.clients.splice(this.clients.indexOf(client), 1);
+        this.clients.splice(
+          this.clients.indexOf(/** @type {ClientConnection} */ (client)),
+          1
+        );
       });
     });
 
+    // @ts-ignore
     this.implementation.close = (callback) => {
       callback();
     };