fix: use CLI specific description for --open-app-name and `--web-so…

…cket-server` (#4215)
webpack · Jan 23, 2022 · 329679a · 329679a
1 parent 617f2d0
commit 329679a
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 45 deletions.
diff --git a/lib/options.json b/lib/options.json
@@ -581,7 +581,10 @@
             {
               "type": "string",
               "minLength": 1,
-              "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+              "description": "Open specified browser.",
+              "cli": {
+                "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+              }
             }
           ],
           "description": "Open specified browser."
@@ -1043,7 +1046,9 @@
           "$ref": "#/definitions/WebSocketServerType"
         }
       ],
-      "description": "Deprecated: please use '--web-socket-server-type' option."
+      "cli": {
+        "description": "Deprecated: please use '--web-socket-server-type' option."
+      }
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -113,7 +113,7 @@
     "tcp-port-used": "^1.0.2",
     "typescript": "^4.2.4",
     "url-loader": "^4.1.1",
-    "webpack": "^5.64.0",
+    "webpack": "^5.67.0",
     "webpack-cli": "^4.7.2",
     "webpack-merge": "^5.8.0"
   },

diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4
@@ -521,7 +521,7 @@ exports[`options validate should throw an error on the "open" option with '{"app
        * options.open.app should be an object:
          object { name?, arguments? }
        * options.open.app should be a non-empty string.
-         -> Open specified browser. Deprecated: please use '--open-app-name'."
+         -> Open specified browser."
 `;
 
 exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = `
@@ -929,7 +929,6 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
-      -> Deprecated: please use '--web-socket-server-type' option.
       Details:
        * options.webSocketServer should be false.
        * options.webSocketServer should be one of these:
@@ -949,7 +948,6 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
-      -> Deprecated: please use '--web-socket-server-type' option.
       Details:
        * options.webSocketServer should be false.
        * options.webSocketServer should be one of these:

diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5
@@ -521,7 +521,7 @@ exports[`options validate should throw an error on the "open" option with '{"app
        * options.open.app should be an object:
          object { name?, arguments? }
        * options.open.app should be a non-empty string.
-         -> Open specified browser. Deprecated: please use '--open-app-name'."
+         -> Open specified browser."
 `;
 
 exports[`options validate should throw an error on the "open" option with '{"foo":"bar"}' value 1`] = `
@@ -929,7 +929,6 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
-      -> Deprecated: please use '--web-socket-server-type' option.
       Details:
        * options.webSocketServer should be false.
        * options.webSocketServer should be one of these:
@@ -949,7 +948,6 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
-      -> Deprecated: please use '--web-socket-server-type' option.
       Details:
        * options.webSocketServer should be false.
        * options.webSocketServer should be one of these:

diff --git a/types/lib/Server.d.ts b/types/lib/Server.d.ts
@@ -978,6 +978,9 @@ declare class Server {
           description: string;
           multiple: boolean;
           path: string;
+          /**
+           * @type {string | undefined}
+           */
           type: string;
         }[];
         description: string;
@@ -1011,7 +1014,7 @@ declare class Server {
           type: string;
           multiple: boolean;
           description: string;
-          path: string;
+          path: string /** @type {ClientConfiguration} */;
         }[];
         description: string;
         simpleType: string;
@@ -1032,7 +1035,7 @@ declare class Server {
         configs: {
           description: string;
           multiple: boolean;
-          /** @type {string} */ path: string;
+          path: string;
           type: string;
         }[];
         description: string;
@@ -1053,7 +1056,7 @@ declare class Server {
       "https-key": {
         configs: {
           type: string;
-          multiple: boolean;
+          /** @type {number | string} */ multiple: boolean;
           description: string;
           path: string;
         }[];
@@ -1142,8 +1145,9 @@ declare class Server {
           type: string;
           multiple: boolean;
           description: string;
-          path: string /** @type {Object<string,string>} */;
+          path: string;
         }[];
+        /** @type {Object<string,string>} */
         description: string;
         negatedDescription: string;
         simpleType: string;
@@ -1152,24 +1156,19 @@ declare class Server {
       "magic-html": {
         configs: {
           type: string;
-          /** @type {any} */
           multiple: boolean;
           description: string;
           path: string;
         }[];
         description: string;
         negatedDescription: string;
         simpleType: string;
-        /** @type {string} */ multiple: boolean;
+        multiple: boolean /** @type {string} */;
       };
       open: {
         configs: {
           type: string;
           multiple: boolean;
-          /**
-           * @private
-           * @returns {Compiler["options"]}
-           */
           description: string;
           path: string;
         }[];
@@ -1197,7 +1196,7 @@ declare class Server {
           path: string;
         }[];
         description: string;
-        /** @type {Compiler} */ simpleType: string;
+        simpleType: string;
         multiple: boolean;
       };
       "open-app-name-reset": {
@@ -1412,7 +1411,7 @@ declare class Server {
         configs: {
           description: string;
           multiple: boolean;
-          path: string;
+          /** @type {ServerConfiguration} */ path: string;
           type: string;
         }[];
         description: string;
@@ -2681,7 +2680,6 @@ declare class Server {
       OpenBoolean: {
         type: string;
       };
-      /** @type {number | string} */
       OpenObject: {
         type: string;
         additionalProperties: boolean;
@@ -2726,7 +2724,6 @@ declare class Server {
                           }
                       )[];
                     };
-                    /** @type {string} */
                     arguments: {
                       items: {
                         type: string;
@@ -2736,11 +2733,15 @@ declare class Server {
                   };
                   minLength?: undefined;
                   description?: undefined;
+                  cli?: undefined;
                 }
               | {
                   type: string;
                   minLength: number;
                   description: string;
+                  cli: {
+                    description: string;
+                  };
                   additionalProperties?: undefined;
                   properties?: undefined;
                 }
@@ -2846,9 +2847,11 @@ declare class Server {
         type: string;
         additionalProperties: boolean;
         properties: {
+          /** @type {any} */
           passphrase: {
             type: string;
-            description: string;
+            /** @type {any} */
+            description: string /** @type {any} */;
           };
           requestCert: {
             type: string;
@@ -2870,7 +2873,7 @@ declare class Server {
                         }
                     )[];
                   };
-                  instanceof?: undefined;
+                  /** @type {string} */ instanceof?: undefined;
                 }
               | {
                   type: string;
@@ -2901,7 +2904,7 @@ declare class Server {
                         }
                     )[];
                   };
-                  instanceof?: undefined;
+                  /** @type {MultiCompiler} */ instanceof?: undefined;
                 }
               | {
                   type: string;
@@ -2919,7 +2922,6 @@ declare class Server {
           cert: {
             anyOf: (
               | {
-                  /** @type {MultiCompiler} */
                   type: string;
                   items: {
                     anyOf: (
@@ -3242,7 +3244,9 @@ declare class Server {
               enum?: undefined;
             }
         )[];
-        description: string;
+        cli: {
+          description: string;
+        };
       };
       WebSocketServerFunction: {
         instanceof: string;
@@ -3321,14 +3325,16 @@ declare class Server {
         $ref: string;
       };
       onListening: {
-        $ref: string;
+        $ref: string /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       open: {
         $ref: string;
       };
       port: {
-        $ref: string;
+        $ref: string /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       proxy: {
         $ref: string;
       };