fix: schema for server option

snitin315 · snitin315 · commit 250107f3e123 · 2021-11-01T18:07:08.000-07:00
diff --git a/lib/options.json b/lib/options.json
@@ -636,9 +636,6 @@
         {
           "$ref": "#/definitions/ServerEnum"
         },
-        {
-          "$ref": "#/definitions/ServerString"
-        },
         {
           "$ref": "#/definitions/ServerObject"
         }
@@ -655,13 +652,6 @@
         "exclude": true
       }
     },
-    "ServerString": {
-      "type": "string",
-      "minLength": 1,
-      "cli": {
-        "exclude": true
-      }
-    },
     "ServerObject": {
       "type": "object",
       "properties": {
diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4
@@ -617,7 +617,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"ca":true}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -634,7 +634,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"cert":true}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -651,7 +651,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"key":10}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -674,7 +674,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"pfx":10}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -694,6 +694,19 @@ exports[`options validate should throw an error on the "server" option with '{"t
    -> Request for an SSL certificate."
 `;
 
+exports[`options validate should throw an error on the "server" option with 'invalid' value 1`] = `
+"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
+ - options.server should be one of these:
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
+   -> Allows to set server and options (by default 'http').
+   -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
+   Details:
+    * options.server should be one of these:
+      \\"http\\" | \\"https\\" | \\"spdy\\"
+    * options.server should be an object:
+      object { type?, options? }"
+`;
+
 exports[`options validate should throw an error on the "static" option with '' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.static should be a non-empty string."
diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5
@@ -617,7 +617,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"ca":true}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -634,7 +634,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"cert":true}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -651,7 +651,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"key":10}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -674,7 +674,7 @@ exports[`options validate should throw an error on the "server" option with '{"t
 exports[`options validate should throw an error on the "server" option with '{"type":"https","options":{"pfx":10}}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.server should be one of these:
-   \\"http\\" | \\"https\\" | \\"spdy\\" | non-empty string | object { type?, options? }
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
    -> Allows to set server and options (by default 'http').
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
    Details:
@@ -694,6 +694,19 @@ exports[`options validate should throw an error on the "server" option with '{"t
    -> Request for an SSL certificate."
 `;
 
+exports[`options validate should throw an error on the "server" option with 'invalid' value 1`] = `
+"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
+ - options.server should be one of these:
+   \\"http\\" | \\"https\\" | \\"spdy\\" | object { type?, options? }
+   -> Allows to set server and options (by default 'http').
+   -> Read more at https://webpack.js.org/configuration/dev-server/#devserverserver
+   Details:
+    * options.server should be one of these:
+      \\"http\\" | \\"https\\" | \\"spdy\\"
+    * options.server should be an object:
+      object { type?, options? }"
+`;
+
 exports[`options validate should throw an error on the "static" option with '' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.static should be a non-empty string."
diff --git a/test/validate-options.test.js b/test/validate-options.test.js
@@ -415,6 +415,7 @@ const tests = {
       },
     ],
     failure: [
+      "invalid",
       {
         type: "https",
         additional: "test",

Original file line number	Diff line number	Diff line change
`@@ -636,9 +636,6 @@`
`636`	`636`	`{`
`637`	`637`	`"$ref": "#/definitions/ServerEnum"`
`638`	`638`	`},`
`639`		`- {`
`640`		`- "$ref": "#/definitions/ServerString"`
`641`		`- },`
`642`	`639`	`{`
`643`	`640`	`"$ref": "#/definitions/ServerObject"`
`644`	`641`	`}`
`@@ -655,13 +652,6 @@`
`655`	`652`	`"exclude": true`
`656`	`653`	`}`
`657`	`654`	`},`
`658`		`- "ServerString": {`
`659`		`- "type": "string",`
`660`		`- "minLength": 1,`
`661`		`- "cli": {`
`662`		`- "exclude": true`
`663`		`- }`
`664`		`- },`
`665`	`655`	`"ServerObject": {`
`666`	`656`	`"type": "object",`
`667`	`657`	`"properties": {`
Original file line number	Diff line number	Diff line change
`@@ -415,6 +415,7 @@ const tests = {`
`415`	`415`	`},`
`416`	`416`	`],`
`417`	`417`	`failure: [`
	`418`	`+ "invalid",`
`418`	`419`	`{`
`419`	`420`	`type: "https",`
`420`	`421`	`additional: "test",`