feat: allow string value for '--hot'

webpack · Feb 19, 2021 · 89294ac · 89294ac
1 parent 74ed07b
commit 89294ac
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/packages/webpack-cli/lib/webpack-cli.js b/packages/webpack-cli/lib/webpack-cli.js
@@ -307,7 +307,7 @@ class WebpackCLI {
             {
                 name: 'hot',
                 alias: 'h',
-                type: Boolean,
+                type: [Boolean, String],
                 negative: true,
                 description: 'Enables Hot Module Replacement',
                 negatedDescription: 'Disables Hot Module Replacement.',
@@ -1383,6 +1383,11 @@ class WebpackCLI {
             process.exit(2);
         }
 
+        if (typeof options.hot === 'string' && options.hot !== 'only') {
+            this.logger.error(`'${options.hot}' is an invalid value for the --hot option. Use 'only' instead.`);
+            process.exit(2);
+        }
+
         const outputHints = (configOptions) => {
             if (
                 configOptions.watch &&

diff --git a/test/hot/hot-flag.test.js b/test/hot/hot-flag.test.js
@@ -13,6 +13,23 @@ describe('--hot flag', () => {
         expect(readFileSync(resolve(__dirname, './dist/main.js')).toString()).toContain('webpackHotUpdate');
     });
 
+    it('should be successful when --hot=only is passed', () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['--hot', 'only']);
+
+        expect(exitCode).toBe(0);
+        expect(stderr).toBeFalsy();
+        expect(stdout).toBeTruthy();
+        expect(readFileSync(resolve(__dirname, './dist/main.js')).toString()).toContain('webpackHotUpdate');
+    });
+
+    it('should throw an error for invalid value', () => {
+        const { exitCode, stderr, stdout } = run(__dirname, ['--hot', 'unknown']);
+
+        expect(exitCode).toBe(2);
+        expect(stderr).toContain(`[webpack-cli] 'unknown' is an invalid value for the --hot option. Use 'only' instead.`);
+        expect(stdout).toBeFalsy();
+    });
+
     it('should be successful when --no-hot is passed', () => {
         const { exitCode, stderr, stdout } = run(__dirname, ['--no-hot']);