webpack-dev-server 4.0.0 → 4.2.1

package/lib/options.json

@@ -71,12 +71,14 @@
     },
     "ClientLogging": {
       "enum": ["none", "error", "warn", "info", "log", "verbose"],
-      "decription": "Allows to set log level in the browser."
+      "decription": "Allows to set log level in the browser.",
+      "link": "https://webpack.js.org/configuration/dev-server/#logging"
     },
     "ClientOverlay": {
       "anyOf": [
         {
           "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"
         },
         {
@@ -97,6 +99,7 @@
     },
     "ClientProgress": {
       "description": "Prints compilation progress in percentage in the browser.",
+      "link": "https://webpack.js.org/configuration/dev-server/#progress",
       "type": "boolean"
     },
     "ClientWebSocketTransport": {
@@ -108,7 +111,8 @@
           "$ref": "#/definitions/ClientWebSocketTransportString"
         }
       ],
-      "description": "Allows to set custom web socket transport to communicate with dev server."
+      "description": "Allows to set custom web socket transport to communicate with dev server.",
+      "link": "https://webpack.js.org/configuration/dev-server/#websockettransport"
     },
     "ClientWebSocketTransportEnum": {
       "enum": ["sockjs", "ws"]
@@ -119,6 +123,7 @@
     },
     "ClientWebSocketURL": {
       "description": "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).",
+      "link": "https://webpack.js.org/configuration/dev-server/#websocketurl",
       "anyOf": [
         {
           "type": "string",
@@ -196,7 +201,7 @@
         },
         {
           "type": "object",
-          "additionalProperties": false,
+          "additionalProperties": true,
           "properties": {
             "passphrase": {
               "type": "string",
@@ -206,8 +211,45 @@
               "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"
                 },
@@ -215,10 +257,23 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL CA certificate."
+              "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
             },
-            "key": {
+            "cert": {
               "anyOf": [
+                {
+                  "type": "array",
+                  "items": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "instanceof": "Buffer"
+                      }
+                    ]
+                  }
+                },
                 {
                   "type": "string"
                 },
@@ -226,10 +281,51 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL key."
+              "description": "Path to an SSL certificate or content of an SSL certificate."
             },
-            "pfx": {
+            "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"
                 },
@@ -237,10 +333,27 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL pfx file."
+              "description": "Path to an SSL key or content of an SSL key."
             },
-            "cert": {
+            "pfx": {
               "anyOf": [
+                {
+                  "type": "array",
+                  "items": {
+                    "anyOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "instanceof": "Buffer"
+                      },
+                      {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    ]
+                  }
+                },
                 {
                   "type": "string"
                 },
@@ -248,7 +361,7 @@
                   "instanceof": "Buffer"
                 }
               ],
-              "description": "Path to an SSL certificate."
+              "description": "Path to an SSL pfx file or content of an SSL pfx file."
             }
           }
         }
@@ -326,6 +439,11 @@
       "description": "Enables 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').",
+      "link": "https://webpack.js.org/configuration/dev-server/#devservermagichtml"
+    },
     "OnAfterSetupMiddleware": {
       "instanceof": "Function",
       "description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares.",
@@ -514,10 +632,12 @@
         "directory": {
           "type": "string",
           "minLength": 1,
-          "description": "Directory for static contents."
+          "description": "Directory for static contents.",
+          "link": "https://webpack.js.org/configuration/dev-server/#directory"
         },
         "staticOptions": {
           "type": "object",
+          "link": "https://webpack.js.org/configuration/dev-server/#staticoptions",
           "additionalProperties": true
         },
         "publicPath": {
@@ -533,7 +653,8 @@
               "type": "string"
             }
           ],
-          "description": "The static files will be available in the browser under this public path."
+          "description": "The static files will be available in the browser under this public path.",
+          "link": "https://webpack.js.org/configuration/dev-server/#publicpath"
         },
         "serveIndex": {
           "anyOf": [
@@ -545,7 +666,8 @@
               "additionalProperties": true
             }
           ],
-          "description": "Tells dev server to use serveIndex middleware when enabled."
+          "description": "Tells dev server to use serveIndex middleware when enabled.",
+          "link": "https://webpack.js.org/configuration/dev-server/#serveindex"
         },
         "watch": {
           "anyOf": [
@@ -558,7 +680,8 @@
               "link": "https://github.com/paulmillr/chokidar#api"
             }
           ],
-          "description": "Watches for files in static content directory."
+          "description": "Watches for files in static content directory.",
+          "link": "https://webpack.js.org/configuration/dev-server/#watch"
         }
       }
     },
@@ -719,6 +842,9 @@
     "liveReload": {
       "$ref": "#/definitions/LiveReload"
     },
+    "magicHtml": {
+      "$ref": "#/definitions/MagicHTML"
+    },
     "onAfterSetupMiddleware": {
       "$ref": "#/definitions/OnAfterSetupMiddleware"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-server",
-  "version": "4.0.0",
+  "version": "4.2.1",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
@@ -32,7 +32,7 @@
     "release": "standard-version"
   },
   "dependencies": {
-    "ansi-html": "^0.0.7",
+    "ansi-html-community": "^0.0.8",
     "bonjour": "^3.5.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.2",
@@ -55,7 +55,7 @@
     "spdy": "^4.0.2",
     "strip-ansi": "^7.0.0",
     "url": "^0.11.0",
-    "webpack-dev-middleware": "^5.0.0",
+    "webpack-dev-middleware": "^5.1.0",
     "ws": "^8.1.0"
   },
   "devDependencies": {

package/lib/utils/DevServerPlugin.js

@@ -1,352 +0,0 @@
-"use strict";
-
-/**
- * An Entry, it can be of type string or string[] or Object<string | string[],string>
- * @typedef {(string[] | string | Object<string | string[],string>)} Entry
- */
-
-class DevServerPlugin {
-  /**
-   * @param {Object} options - Dev-Server options
-   */
-  constructor(options) {
-    this.options = options;
-  }
-
-  getWebsocketTransport() {
-    let ClientImplementation;
-    let clientImplementationFound = true;
-
-    const isKnownWebSocketServerImplementation =
-      this.options.webSocketServer &&
-      typeof this.options.webSocketServer.type === "string" &&
-      (this.options.webSocketServer.type === "ws" ||
-        this.options.webSocketServer.type === "sockjs");
-
-    let clientTransport;
-
-    if (this.options.client) {
-      if (typeof this.options.client.webSocketTransport !== "undefined") {
-        clientTransport = this.options.client.webSocketTransport;
-      } else if (isKnownWebSocketServerImplementation) {
-        clientTransport = this.options.webSocketServer.type;
-      } else {
-        clientTransport = "ws";
-      }
-    } else {
-      clientTransport = "ws";
-    }
-
-    switch (typeof clientTransport) {
-      case "string":
-        // could be 'sockjs', 'ws', or a path that should be required
-        if (clientTransport === "sockjs") {
-          ClientImplementation = require.resolve(
-            "../../client/clients/SockJSClient"
-          );
-        } else if (clientTransport === "ws") {
-          ClientImplementation = require.resolve(
-            "../../client/clients/WebSocketClient"
-          );
-        } else {
-          try {
-            // eslint-disable-next-line import/no-dynamic-require
-            ClientImplementation = require.resolve(clientTransport);
-          } catch (e) {
-            clientImplementationFound = false;
-          }
-        }
-        break;
-      default:
-        clientImplementationFound = false;
-    }
-
-    if (!clientImplementationFound) {
-      throw new Error(
-        `${
-          !isKnownWebSocketServerImplementation
-            ? "When you use custom web socket implementation you must explicitly specify client.webSocketTransport. "
-            : ""
-        }client.webSocketTransport must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to a JS file via require.resolve(...) which exports a class `
-      );
-    }
-
-    return ClientImplementation;
-  }
-
-  /**
-   * @returns {string}
-   */
-  getWebSocketURL() {
-    const { options } = this;
-    const searchParams = new URLSearchParams();
-
-    /** @type {"ws:" | "wss:" | "http:" | "https:" | "auto:"} */
-    let protocol;
-
-    // We are proxying dev server and need to specify custom `hostname`
-    if (typeof options.client.webSocketURL.protocol !== "undefined") {
-      protocol = options.client.webSocketURL.protocol;
-    } else {
-      protocol = options.https ? "wss:" : "ws:";
-    }
-
-    searchParams.set("protocol", protocol);
-
-    if (typeof options.client.webSocketURL.username !== "undefined") {
-      searchParams.set("username", options.client.webSocketURL.username);
-    }
-
-    if (typeof options.client.webSocketURL.password !== "undefined") {
-      searchParams.set("password", options.client.webSocketURL.password);
-    }
-
-    /** @type {string} */
-    let hostname;
-
-    // SockJS is not supported server mode, so `hostname` and `port` can't specified, let's ignore them
-    // TODO show warning about this
-    const isSockJSType = options.webSocketServer.type === "sockjs";
-
-    // We are proxying dev server and need to specify custom `hostname`
-    if (typeof options.client.webSocketURL.hostname !== "undefined") {
-      hostname = options.client.webSocketURL.hostname;
-    }
-    // Web socket server works on custom `hostname`, only for `ws` because `sock-js` is not support custom `hostname`
-    else if (
-      typeof options.webSocketServer.options.host !== "undefined" &&
-      !isSockJSType
-    ) {
-      hostname = options.webSocketServer.options.host;
-    }
-    // The `host` option is specified
-    else if (typeof this.options.host !== "undefined") {
-      hostname = this.options.host;
-    }
-    // The `port` option is not specified
-    else {
-      hostname = "0.0.0.0";
-    }
-
-    searchParams.set("hostname", hostname);
-
-    /** @type {number | string} */
-    let port;
-
-    // We are proxying dev server and need to specify custom `port`
-    if (typeof options.client.webSocketURL.port !== "undefined") {
-      port = options.client.webSocketURL.port;
-    }
-    // Web socket server works on custom `port`, only for `ws` because `sock-js` is not support custom `port`
-    else if (
-      typeof options.webSocketServer.options.port !== "undefined" &&
-      !isSockJSType
-    ) {
-      port = options.webSocketServer.options.port;
-    }
-    // The `port` option is specified
-    else if (typeof options.port === "number") {
-      port = options.port;
-    }
-    // The `port` option is specified using `string`
-    else if (typeof options.port === "string" && options.port !== "auto") {
-      port = Number(options.port);
-    }
-    // The `port` option is not specified or set to `auto`
-    else {
-      port = "0";
-    }
-
-    searchParams.set("port", String(port));
-
-    /** @type {string} */
-    let pathname = "";
-
-    // We are proxying dev server and need to specify custom `pathname`
-    if (typeof options.client.webSocketURL.pathname !== "undefined") {
-      pathname = options.client.webSocketURL.pathname;
-    }
-    // Web socket server works on custom `path`
-    else if (
-      typeof options.webSocketServer.options.prefix !== "undefined" ||
-      typeof options.webSocketServer.options.path !== "undefined"
-    ) {
-      pathname =
-        options.webSocketServer.options.prefix ||
-        options.webSocketServer.options.path;
-    }
-
-    searchParams.set("pathname", pathname);
-
-    if (typeof options.client.logging !== "undefined") {
-      searchParams.set("logging", options.client.logging);
-    }
-
-    return searchParams.toString();
-  }
-
-  /**
-   * @returns {string}
-   */
-  getClientEntry() {
-    /** @type {string} */
-    const webSocketURL = this.options.webSocketServer
-      ? this.getWebSocketURL()
-      : "";
-
-    return `${require.resolve("../../client/index.js")}?${webSocketURL}`;
-  }
-
-  getHotEntry() {
-    const { options } = this;
-
-    /** @type {(string[] | string)} */
-    let hotEntry;
-
-    if (options.hot === "only") {
-      hotEntry = require.resolve("webpack/hot/only-dev-server");
-    } else if (options.hot) {
-      hotEntry = require.resolve("webpack/hot/dev-server");
-    }
-
-    return hotEntry;
-  }
-
-  /**
-   * @param {Object} compilerOptions
-   * @returns {boolean}
-   */
-  // eslint-disable-next-line class-methods-use-this
-  isWebTarget(compilerOptions) {
-    return compilerOptions.externalsPresets
-      ? compilerOptions.externalsPresets.web
-      : [
-          "web",
-          "webworker",
-          "electron-preload",
-          "electron-renderer",
-          "node-webkit",
-          // eslint-disable-next-line no-undefined
-          undefined,
-          null,
-        ].includes(compilerOptions.target);
-  }
-
-  /**
-   * Apply the plugin
-   * @param {Object} compiler the compiler instance
-   * @returns {void}
-   */
-  apply(compiler) {
-    /**
-     *
-     * Description of the option for checkInject method
-     * @typedef {Function} checkInjectOptionsParam
-     * @param {Object} _config - compilerConfig
-     * @return {Boolean}
-     */
-
-    const additionalEntries = [];
-
-    // TODO maybe empty empty client
-    if (this.options.client && this.isWebTarget(compiler.options)) {
-      const clientEntry = this.getClientEntry();
-
-      additionalEntries.push(clientEntry);
-    }
-
-    if (this.options.hot) {
-      const hotEntry = this.getHotEntry();
-
-      additionalEntries.push(hotEntry);
-    }
-
-    const webpack = compiler.webpack || require("webpack");
-
-    // use a hook to add entries if available
-    if (typeof webpack.EntryPlugin !== "undefined") {
-      for (const additionalEntry of additionalEntries) {
-        new webpack.EntryPlugin(compiler.context, additionalEntry, {
-          // eslint-disable-next-line no-undefined
-          name: undefined,
-        }).apply(compiler);
-      }
-    } else {
-      /**
-       * prependEntry Method for webpack 4
-       * @param {Entry} originalEntry
-       * @param {Entry} newAdditionalEntries
-       * @returns {Entry}
-       */
-      const prependEntry = (originalEntry, newAdditionalEntries) => {
-        if (typeof originalEntry === "function") {
-          return () =>
-            Promise.resolve(originalEntry()).then((entry) =>
-              prependEntry(entry, newAdditionalEntries)
-            );
-        }
-
-        if (
-          typeof originalEntry === "object" &&
-          !Array.isArray(originalEntry)
-        ) {
-          /** @type {Object<string,string>} */
-          const clone = {};
-
-          Object.keys(originalEntry).forEach((key) => {
-            // entry[key] should be a string here
-            const entryDescription = originalEntry[key];
-
-            clone[key] = prependEntry(entryDescription, newAdditionalEntries);
-          });
-
-          return clone;
-        }
-
-        // in this case, entry is a string or an array.
-        // make sure that we do not add duplicates.
-        /** @type {Entry} */
-        const entriesClone = additionalEntries.slice(0);
-
-        [].concat(originalEntry).forEach((newEntry) => {
-          if (!entriesClone.includes(newEntry)) {
-            entriesClone.push(newEntry);
-          }
-        });
-
-        return entriesClone;
-      };
-
-      compiler.options.entry = prependEntry(
-        compiler.options.entry || "./src",
-        additionalEntries
-      );
-      compiler.hooks.entryOption.call(
-        compiler.options.context,
-        compiler.options.entry
-      );
-    }
-
-    const providePlugin = new webpack.ProvidePlugin({
-      __webpack_dev_server_client__: this.getWebsocketTransport(),
-    });
-
-    providePlugin.apply(compiler);
-
-    compiler.options.plugins = compiler.options.plugins || [];
-
-    if (
-      this.options.hot &&
-      !compiler.options.plugins.find(
-        (p) => p.constructor === webpack.HotModuleReplacementPlugin
-      )
-    ) {
-      // apply the HMR plugin, if it didn't exist before.
-      const plugin = new webpack.HotModuleReplacementPlugin();
-
-      plugin.apply(compiler);
-    }
-  }
-}
-
-module.exports = DevServerPlugin;