feat: added --client-overlay flag (#3148)

Author: snitin315

README.md

@@ -93,6 +93,8 @@ Options:
   --no-http2                 Do not use HTTP/2.
   --bonjour                  Broadcasts the server via ZeroConf networking on start.
   --client-progress          Print compilation progress in percentage in the browser.
+  --client-overlay           Show a full-screen overlay in the browser when there are compiler errors or warnings.
+  --no-client-overlay        Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
   --setup-exit-signals       Close and exit the process on SIGINT and SIGTERM.
   --no-setup-exit-signals    Do not close and exit the process on SIGNIT and SIGTERM.
   --open [value]             Open the default browser, or optionally specify a browser name.

bin/cli-flags.js

@@ -98,6 +98,24 @@ module.exports = {
         delete opts.clientProgress;
       },
     },
+    {
+      name: 'client-overlay',
+      type: Boolean,
+      configs: [
+        {
+          type: 'boolean',
+        },
+      ],
+      description:
+        'Show a full-screen overlay in the browser when there are compiler errors or warnings.',
+      negatedDescription:
+        'Do not show a full-screen overlay in the browser when there are compiler errors or warnings.',
+      processor(opts) {
+        opts.client = opts.client || {};
+        opts.client.overlay = opts.clientOverlay;
+        delete opts.clientOverlay;
+      },
+    },
     {
       name: 'setup-exit-signals',
       type: Boolean,

test/cli/cli.test.js

@@ -291,6 +291,15 @@ describe('CLI', () => {
       .catch(done);
   });
 
+  it('--client-overlay', (done) => {
+    testBin('--client-overlay')
+      .then((output) => {
+        expect(output.exitCode).toEqual(0);
+        done();
+      })
+      .catch(done);
+  });
+
   it('should log public path', (done) => {
     testBin(
       '--no-color',