fix: show warning if bail and watch are used together (#1804)

* fix: show warning if bail and watch are used together

* fix: watch

* tests: update

* chore: add comments

Co-authored-by: James George <[email protected]>

Author: snitin315

packages/webpack-cli/lib/groups/BasicGroup.js

@@ -36,6 +36,9 @@ class BasicGroup extends GroupHelper {
             if (arg === 'name') {
                 options.name = args[arg];
             }
+            if (arg === 'watch') {
+                options.watch = true;
+            }
             if (arg === 'entry') {
                 options[arg] = this.resolveFilePath(args[arg], 'index.js');
                 if (options[arg].length === 0) {

packages/webpack-cli/lib/utils/Compiler.js

@@ -1,5 +1,6 @@
 const webpack = require('webpack');
 const logger = require('./logger');
+const bailAndWatchWarning = require('./warnings/bailAndWatchWarning');
 const { CompilerOutput } = require('./CompilerOutput');
 
 class Compiler {
@@ -119,9 +120,11 @@ class Compiler {
 
         if (this.compiler.compilers) {
             this.compiler.compilers.forEach((comp, idx) => {
+                bailAndWatchWarning(comp); //warn the user if bail and watch both are used together
                 this.setUpHookForCompilation(comp, outputOptions, options[idx]);
             });
         } else {
+            bailAndWatchWarning(this.compiler);
             this.setUpHookForCompilation(this.compiler, outputOptions, options);
         }
 

packages/webpack-cli/lib/utils/warnings/bailAndWatchWarning.js

@@ -0,0 +1,14 @@
+const logger = require('../logger');
+
+/**
+ * warn the user if bail and watch both are used together
+ * @param {Object} webpack compiler
+ * @returns {void}
+ */
+const bailAndWatchWarning = (compiler) => {
+    if (compiler.options.bail && compiler.options.watch) {
+        logger.warn('You are using "bail" with "watch". "bail" will still exit webpack when the first error is found.');
+    }
+};
+
+module.exports = bailAndWatchWarning;

test/bail/bail-and-watch-warning.test.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const { run } = require('../utils/test-utils');
+
+describe('bail and watch warning', () => {
+    it('should log warning in case of single compiler', () => {
+        const { stderr, stdout } = run(__dirname, ['-c', 'single-webpack.config.js']);
+
+        expect(stderr).toContain(`You are using "bail" with "watch". "bail" will still exit webpack when the first error is found.`);
+        expect(stdout).toBeTruthy();
+    });
+
+    it('should log warning in case of multiple compilers', () => {
+        const { stderr, stdout } = run(__dirname, ['-c', 'multi-webpack.config.js']);
+
+        expect(stderr).toContain(`You are using "bail" with "watch". "bail" will still exit webpack when the first error is found.`);
+        expect(stdout).toBeTruthy();
+    });
+
+    it('should log not log warning if both are not true', () => {
+        const { stderr, stdout } = run(__dirname, ['-c', 'third-webpack.config.js']);
+
+        expect(stderr).not.toContain(`You are using "bail" with "watch". "bail" will still exit webpack when the first error is found.`);
+        expect(stdout).toBeTruthy();
+    });
+});

test/bail/multi-webpack.config.js

@@ -0,0 +1,20 @@
+module.exports = [
+    {
+        output: {
+            filename: './dist-first.js',
+        },
+        name: 'first',
+        entry: './src/first.js',
+        mode: 'development',
+    },
+    {
+        output: {
+            filename: './dist-second.js',
+        },
+        name: 'second',
+        entry: './src/second.js',
+        mode: 'production',
+        bail: true,
+        watch: true,
+    },
+];

test/bail/single-webpack.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    entry: './src/first.js',
+    mode: 'development',
+    bail: true,
+    watch: true,
+};

test/bail/src/first.js

@@ -0,0 +1 @@
+console.log('bail and watch warning test first');

test/bail/src/second.js

@@ -0,0 +1 @@
+console.log('bail and watch warning test second');

test/bail/third-webpack.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    entry: './src/first.js',
+    mode: 'development',
+    bail: true,
+};