webpack-dev-server 4.7.2 → 4.8.0

package/README.md

@@ -27,6 +27,7 @@ fast in-memory access to the webpack assets.
   - [With the CLI](#with-the-cli)
   - [With NPM Scripts](#with-npm-scripts)
   - [With the API](#with-the-api)
+  - [With TypeScript](#with-typescript)
   - [The Result](#the-result)
 - [Browser Support](#browser-support)
 - [Support](#support)
@@ -42,6 +43,18 @@ First things first, install the module:
 npm install webpack-dev-server --save-dev
 ```
 
+or
+
+```console
+yarn add -D webpack-dev-server
+```
+
+or
+
+```console
+pnpm add -D webpack-dev-server
+```
+
 _Note: While you can install and run webpack-dev-server globally, we recommend
 installing it locally. webpack-dev-server will always use a local installation
 over a global one._
@@ -90,18 +103,18 @@ Options:
                                             you are proxying dev server, by default is 'auto').
   --bonjour                                 Allows to broadcasts dev server via ZeroConf networking on start.
   --no-bonjour                              Disallows to broadcasts dev server via ZeroConf networking on start.
-  --no-client                               Negative 'client' option.
+  --no-client                               Disables client script.
   --client-logging <value>                  Allows to set log level in the browser.
   --client-overlay                          Enables a full-screen overlay in the browser when there are compiler errors or warnings.
-  --no-client-overlay                       Disables a full-screen overlay in the browser when there are compiler errors or warnings.
+  --no-client-overlay                       Disables the full-screen overlay in the browser when there are compiler errors or warnings.
   --client-overlay-errors                   Enables a full-screen overlay in the browser when there are compiler errors.
-  --no-client-overlay-errors                Negative 'client-overlay-errors' option.
+  --no-client-overlay-errors                Disables the full-screen overlay in the browser when there are compiler errors.
   --client-overlay-warnings                 Enables a full-screen overlay in the browser when there are compiler warnings.
-  --no-client-overlay-warnings              Negative 'client-overlay-warnings' option.
+  --no-client-overlay-warnings              Disables the full-screen overlay in the browser when there are compiler warnings.
   --client-progress                         Prints compilation progress in percentage in the browser.
   --no-client-progress                      Does not print compilation progress in percentage in the browser.
   --client-reconnect [value]                Tells dev-server the number of times it should try to reconnect the client.
-  --no-client-reconnect                     Tells dev-server to not to try to connect the client.
+  --no-client-reconnect                     Tells dev-server to not to try to reconnect the client.
   --client-web-socket-transport <value>     Allows to set custom web socket transport to communicate with dev server.
   --client-web-socket-url <value>           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).
   --client-web-socket-url-hostname <value>  Tells clients connected to devServer to use the provided hostname.
@@ -114,7 +127,7 @@ Options:
   --no-compress                             Disables gzip compression for everything served.
   --history-api-fallback                    Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5
                                             History API.
-  --no-history-api-fallback                 Negative 'history-api-fallback' option.
+  --no-history-api-fallback                 Disallows to proxy requests through a specified index page.
   --host <value>                            Allows to specify a hostname to use.
   --hot [value]                             Enables Hot Module Replacement.
   --no-hot                                  Disables Hot Module Replacement.
@@ -237,6 +250,30 @@ While it's recommended to run webpack-dev-server via the CLI, you may also choos
 
 See the related [API documentation for `webpack-dev-server`](https://webpack.js.org/api/webpack-dev-server/).
 
+### With TypeScript
+
+If you use TypeScript in the webpack config, you'll need to properly type `devServer` property in order to avoid TS errors (e.g. `'devServer' does not exist in type 'Configuration'`). For that use either:
+
+```ts
+/// <reference path="node_modules/webpack-dev-server/types/lib/Server.d.ts"/>
+import type { Configuration } from "webpack";
+
+// Your logic
+```
+
+Or you can import the type from `webpack-dev-server`, i.e.
+
+```ts
+import type { Configuration as DevServerConfiguration } from "webpack-dev-server";
+import type { Configuration } from "webpack";
+
+const devServer: DevServerConfiguration = {};
+const config: Configuration = { devServer };
+
+// module.exports
+export default config;
+```
+
 ### The Result
 
 Either method will start a server instance and begin listening for connections

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,
   },
@@ -61,6 +61,7 @@ module.exports = {
       {
         description:
           "Allows to specify options for client script in the browser or disable client script.",
+        negatedDescription: "Disables client script.",
         multiple: false,
         path: "client",
         type: "enum",
@@ -93,13 +94,13 @@ module.exports = {
         multiple: false,
         description:
           "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
+        negatedDescription:
+          "Disables the 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,
   },
@@ -110,6 +111,8 @@ module.exports = {
         multiple: false,
         description:
           "Enables a full-screen overlay in the browser when there are compiler errors.",
+        negatedDescription:
+          "Disables the full-screen overlay in the browser when there are compiler errors.",
         path: "client.overlay.errors",
       },
     ],
@@ -125,6 +128,8 @@ module.exports = {
         multiple: false,
         description:
           "Enables a full-screen overlay in the browser when there are compiler warnings.",
+        negatedDescription:
+          "Disables the full-screen overlay in the browser when there are compiler warnings.",
         path: "client.overlay.warnings",
       },
     ],
@@ -140,12 +145,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 +161,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 reconnect the client.",
         path: "client.reconnect",
       },
       {
@@ -168,7 +175,6 @@ module.exports = {
     ],
     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 +327,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,
   },
@@ -336,6 +342,8 @@ module.exports = {
         multiple: false,
         description:
           "Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5 History API.",
+        negatedDescription:
+          "Disallows to proxy requests through a specified index page.",
         path: "historyApiFallback",
       },
     ],
@@ -370,6 +378,7 @@ module.exports = {
         type: "boolean",
         multiple: false,
         description: "Enables Hot Module Replacement.",
+        negatedDescription: "Disables Hot Module Replacement.",
         path: "hot",
       },
       {
@@ -381,7 +390,6 @@ module.exports = {
       },
     ],
     description: "Enables Hot Module Replacement.",
-    negatedDescription: "Disables Hot Module Replacement.",
     simpleType: "string",
     multiple: false,
   },
@@ -392,12 +400,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 +416,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 +628,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 +664,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 +681,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 +705,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 +794,6 @@ module.exports = {
       },
     ],
     description: "Opens specified page in browser.",
-    negatedDescription: "Does not open specified page in browser.",
     simpleType: "string",
     multiple: true,
   },
@@ -1023,6 +1030,7 @@ module.exports = {
     configs: [
       {
         description: "Request for an SSL certificate.",
+        negatedDescription: "Does not request for an SSL certificate.",
         multiple: false,
         path: "server.options.requestCert",
         type: "boolean",
@@ -1060,6 +1068,8 @@ module.exports = {
         multiple: false,
         description:
           "Allows to configure options for serving static files from directory (by default 'public' directory).",
+        negatedDescription:
+          "Disallows to configure options for serving static files from directory.",
         path: "static",
       },
     ],
@@ -1140,12 +1150,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 +1165,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,
   },
@@ -1198,6 +1209,7 @@ module.exports = {
       {
         description:
           "Deprecated: please use '--web-socket-server-type' option.",
+        negatedDescription: "Disallows to set web socket server and options.",
         multiple: false,
         path: "webSocketServer",
         type: "enum",

package/client/index.js

@@ -1,7 +1,7 @@
 /* global __resourceQuery, __webpack_hash__ */
 /// <reference types="webpack/module" />
 import webpackHotLog from "webpack/hot/log.js";
-import stripAnsi from "./modules/strip-ansi/index.js";
+import stripAnsi from "./utils/stripAnsi.js";
 import parseURL from "./utils/parseURL.js";
 import socket from "./socket.js";
 import { formatProblem, show, hide } from "./overlay.js";