fix: update description for --no-history-api-fallback (#4277)

* fix: update description for `--no-history-api-fallback` * test: update snapshots
webpack · Feb 14, 2022 · d63a0a2 · d63a0a2
1 parent 984c5b6
commit d63a0a2
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -126,7 +126,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.

diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -340,6 +340,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",
       },
     ],

diff --git a/lib/options.json b/lib/options.json
@@ -451,7 +451,10 @@
     "HistoryApiFallback": {
       "anyOf": [
         {
-          "type": "boolean"
+          "type": "boolean",
+          "cli": {
+            "negatedDescription": "Disallows to proxy requests through a specified index page."
+          }
         },
         {
           "type": "object",

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack4 b/test/cli/__snapshots__/basic.test.js.snap.webpack4
@@ -81,7 +81,7 @@ Options:
   --compress                                Enables gzip compression for everything served.
   --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.

diff --git a/test/cli/__snapshots__/basic.test.js.snap.webpack5 b/test/cli/__snapshots__/basic.test.js.snap.webpack5
@@ -82,7 +82,7 @@ Options:
   --compress                                Enables gzip compression for everything served.
   --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.

diff --git a/types/lib/Server.d.ts b/types/lib/Server.d.ts
@@ -2149,17 +2149,21 @@ declare class Server {
         anyOf: (
           | {
               type: string;
+              cli: {
+                negatedDescription: string;
+              };
               description?: undefined;
               link?: undefined;
             }
           | {
               type: string;
               description: string;
               link: string;
+              cli?: undefined;
             }
         )[];
         description: string;
-        link: string /** @type {WebSocketURL} */;
+        link: string;
       };
       Host: {
         description: string;
@@ -2181,7 +2185,7 @@ declare class Server {
         anyOf: (
           | {
               type: string;
-              /** @type {string} */ enum?: undefined;
+              enum?: undefined;
             }
           | {
               enum: string[];
@@ -2264,7 +2268,7 @@ declare class Server {
       OpenBoolean: {
         type: string;
         cli: {
-          negatedDescription: string;
+          negatedDescription: string /** @type {ClientConfiguration} */;
         };
       };
       OpenObject: {
@@ -2376,22 +2380,21 @@ declare class Server {
             }
           | {
               type: string;
+              /** @type {any} */
               items: {
                 anyOf: (
                   | {
                       type: string;
                       instanceof?: undefined;
                     }
                   | {
-                      /** @type {any} */
                       instanceof: string;
                       type?: undefined;
                     }
                 )[];
               };
             }
         )[];
-        /** @type {any} */
         description: string;
         link: string;
       };
@@ -2405,6 +2408,7 @@ declare class Server {
       ServerType: {
         enum: string[];
       };
+      /** @type {MultiCompiler} */
       ServerEnum: {
         enum: string[];
         cli: {
@@ -2428,9 +2432,9 @@ declare class Server {
           };
           options: {
             $ref: string;
-          } /** @type {MultiCompiler} */;
+          };
         };
-        /** @type {MultiCompiler} */ additionalProperties: boolean;
+        additionalProperties: boolean;
       };
       ServerOptions: {
         type: string;
@@ -2837,17 +2841,17 @@ declare class Server {
               enum?: undefined;
             }
         )[];
-        /** @type {ServerOptions} */
         cli: {
           description: string;
-        };
+        } /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       WebSocketServerFunction: {
         instanceof: string;
       };
       WebSocketServerObject: {
-        type: string;
         /** @type {ServerOptions} */
+        type: string;
         properties: {
           type: {
             anyOf: {
@@ -2878,8 +2882,9 @@ declare class Server {
         $ref: string;
       };
       client: {
-        $ref: string;
+        $ref: string /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       compress: {
         $ref: string;
       };
@@ -2917,7 +2922,7 @@ declare class Server {
         $ref: string;
       };
       onBeforeSetupMiddleware: {
-        $ref: string /** @type {any} */;
+        $ref: string;
       };
       onListening: {
         $ref: string;