refactor: move overlay option to client (#2888)

BREAKING CHANGE: the `overlay` option was moved into the `client` option
webpack · Dec 1, 2020 · 763cde1 · 763cde1
1 parent cee170c
commit 763cde1
Show file tree

Hide file tree

Showing 5 changed files with 71 additions and 65 deletions.
diff --git a/lib/Server.js b/lib/Server.js
@@ -567,8 +567,8 @@ class Server {
         this.sockWrite([connection], 'progress', this.options.client.progress);
       }
 
-      if (this.options.clientOverlay) {
-        this.sockWrite([connection], 'overlay', this.options.clientOverlay);
+      if (this.options.client.overlay) {
+        this.sockWrite([connection], 'overlay', this.options.client.overlay);
       }
 
       if (!this.stats) {

diff --git a/lib/options.json b/lib/options.json
@@ -86,6 +86,24 @@
         },
         "progress": {
           "type": "boolean"
+        },
+        "overlay": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "errors": {
+                  "type": "boolean"
+                },
+                "warnings": {
+                  "type": "boolean"
+                }
+              }
+            }
+          ]
         }
       },
       "additionalProperties": false
@@ -264,24 +282,6 @@
         }
       ]
     },
-    "overlay": {
-      "anyOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "errors": {
-              "type": "boolean"
-            },
-            "warnings": {
-              "type": "boolean"
-            }
-          }
-        }
-      ]
-    },
     "port": {
       "anyOf": [
         {
@@ -403,7 +403,6 @@
       "onListening": "should be {Function} (https://webpack.js.org/configuration/dev-server/#onlistening)",
       "open": "should be {String|Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserveropen)",
       "openPage": "should be {String|Array} (https://webpack.js.org/configuration/dev-server/#devserveropenpage)",
-      "overlay": "should be {Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserveroverlay)",
       "port": "should be {Number|String|Null} (https://webpack.js.org/configuration/dev-server/#devserverport)",
       "proxy": "should be {Object|Array} (https://webpack.js.org/configuration/dev-server/#devserverproxy)",
       "public": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpublic)",

diff --git a/test/Validation.test.js b/test/Validation.test.js
@@ -33,10 +33,6 @@ describe('Validation', () => {
         name: 'invalid `injectHot` configuration',
         config: { injectHot: 1 },
       },
-      {
-        name: 'invalid `overlay` configuration',
-        config: { overlay: { errors: 1 } },
-      },
       {
         name: 'invalid `static` configuration',
         config: { static: [0] },

diff --git a/test/__snapshots__/Validation.test.js.snap b/test/__snapshots__/Validation.test.js.snap
@@ -18,11 +18,6 @@ exports[`Validation validation should fail validation for invalid \`injectHot\`
     * configuration.injectHot should be an instance of function."
 `;
 
-exports[`Validation validation should fail validation for invalid \`overlay\` configuration 1`] = `
-"Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.overlay.errors should be a boolean."
-`;
-
 exports[`Validation validation should fail validation for invalid \`static\` configuration 1`] = `
 "Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.static should be one of these:
@@ -39,5 +34,5 @@ exports[`Validation validation should fail validation for invalid \`static\` con
 exports[`Validation validation should fail validation for no additional properties 1`] = `
 "Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration has an unknown property 'additional'. These properties are valid:
-   object { bonjour?, client?, compress?, dev?, firewall?, headers?, historyApiFallback?, host?, hot?, http2?, https?, injectClient?, injectHot?, liveReload?, onAfterSetupMiddleware?, onBeforeSetupMiddleware?, onListening?, open?, openPage?, overlay?, port?, proxy?, public?, setupExitSignals?, static?, stdin?, transportMode?, useLocalIp? }"
+   object { bonjour?, client?, compress?, dev?, firewall?, headers?, historyApiFallback?, host?, hot?, http2?, https?, injectClient?, injectHot?, liveReload?, onAfterSetupMiddleware?, onBeforeSetupMiddleware?, onListening?, open?, openPage?, port?, proxy?, public?, setupExitSignals?, static?, stdin?, transportMode?, useLocalIp? }"
 `;
diff --git a/test/options.test.js b/test/options.test.js
@@ -207,6 +207,37 @@ describe('options', () => {
               progress: false,
             },
           },
+          {
+            client: {
+              overlay: true,
+            },
+          },
+          {
+            client: {
+              overlay: {},
+            },
+          },
+          {
+            client: {
+              overlay: {
+                error: true,
+              },
+            },
+          },
+          {
+            client: {
+              overlay: {
+                warnings: true,
+              },
+            },
+          },
+          {
+            client: {
+              overlay: {
+                arbitrary: '',
+              },
+            },
+          },
         ],
         failure: [
           'whoops!',
@@ -237,6 +268,25 @@ describe('options', () => {
               progress: '',
             },
           },
+          {
+            client: {
+              overlay: '',
+            },
+          },
+          {
+            client: {
+              overlay: {
+                errors: '',
+              },
+            },
+          },
+          {
+            client: {
+              overlay: {
+                warnings: '',
+              },
+            },
+          },
         ],
       },
       compress: {
@@ -327,40 +377,6 @@ describe('options', () => {
         success: [''],
         failure: [false],
       },
-      overlay: {
-        success: [
-          true,
-          {},
-          {
-            overlay: {
-              errors: true,
-            },
-          },
-          {
-            overlay: {
-              warnings: true,
-            },
-          },
-          {
-            overlay: {
-              arbitrary: '',
-            },
-          },
-        ],
-        failure: [
-          '',
-          {
-            overlay: {
-              errors: '',
-            },
-          },
-          {
-            overlay: {
-              warnings: '',
-            },
-          },
-        ],
-      },
       port: {
         success: ['', 0, null],
         failure: [false],