refactor: remove the hotOnly option (#2409)

evilebottnawi · alexander-akait · commit 8b9040cdb997 · 2020-01-31T18:39:56.000+03:00
BREAKING CHANGE: the `hotOnly` option was remove, please use `hot: "only"` instead
diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -49,16 +49,22 @@ module.exports = {
       describe: 'Print compilation progress in percentage',
       group: BASIC_GROUP,
     },
+    {
+      name: 'hot',
+      type: Boolean,
+      describe: 'Enables/Disables hot mode',
+      group: ADVANCED_GROUP,
+    },
     {
       name: 'hot-only',
       type: Boolean,
-      describe: 'Do not refresh page if HMR fails',
+      describe: 'Enables hot only mode',
       group: ADVANCED_GROUP,
     },
     {
       name: 'stdin',
       type: Boolean,
-      describe: 'close when stdin ends',
+      describe: 'Close when stdin ends',
     },
     {
       name: 'open',
diff --git a/bin/options.js b/bin/options.js
@@ -45,9 +45,14 @@ const options = {
     describe: 'Print compilation progress in percentage',
     group: BASIC_GROUP,
   },
+  hot: {
+    type: 'boolean',
+    describe: 'Enables/Disables hot mode',
+    group: ADVANCED_GROUP,
+  },
   'hot-only': {
     type: 'boolean',
-    describe: 'Do not refresh page if HMR fails',
+    describe: 'Enables hot only mode',
     group: ADVANCED_GROUP,
   },
   stdin: {
diff --git a/lib/Server.js b/lib/Server.js
@@ -92,7 +92,7 @@ class Server {
 
     this.sockets = [];
     this.contentBaseWatchers = [];
-    this.hot = this.options.hot || this.options.hotOnly;
+    this.hot = this.options.hot;
     this.watchOptions = options.watchOptions || {};
 
     // Replace leading and trailing slashes to normalize path
diff --git a/lib/options.json b/lib/options.json
@@ -114,10 +114,14 @@
       ]
     },
     "hot": {
-      "type": "boolean"
-    },
-    "hotOnly": {
-      "type": "boolean"
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "enum": ["only"]
+        }
+      ]
     },
     "http2": {
       "type": "boolean"
@@ -427,7 +431,6 @@
       "historyApiFallback": "should be {Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback)",
       "host": "should be {String|Null} (https://webpack.js.org/configuration/dev-server/#devserverhost)",
       "hot": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhot)",
-      "hotOnly": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhotonly)",
       "http2": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttp2)",
       "https": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttps)",
       "index": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverindex)",
diff --git a/lib/utils/addEntries.js b/lib/utils/addEntries.js
@@ -43,7 +43,7 @@ function addEntries(config, options, server) {
     /** @type {(string[] | string)} */
     let hotEntry;
 
-    if (options.hotOnly) {
+    if (options.hot === 'only') {
       hotEntry = require.resolve('webpack/hot/only-dev-server');
     } else if (options.hot) {
       hotEntry = require.resolve('webpack/hot/dev-server');
@@ -134,7 +134,7 @@ function addEntries(config, options, server) {
 
       config.entry = prependEntry(config.entry || './src', additionalEntries);
 
-      if (options.hot || options.hotOnly) {
+      if (options.hot) {
         config.plugins = config.plugins || [];
         if (
           !config.plugins.find(
diff --git a/lib/utils/createConfig.js b/lib/utils/createConfig.js
@@ -87,13 +87,7 @@ function createConfig(config, argv, { port }) {
   // TODO https://github.com/webpack/webpack-dev-server/issues/616 (v4)
   // We should prefer CLI arg under config, now we always prefer `hot` from `devServer`
   if (!options.hot) {
-    options.hot = argv.hot;
-  }
-
-  // TODO https://github.com/webpack/webpack-dev-server/issues/616 (v4)
-  // We should prefer CLI arg under config, now we always prefer `hotOnly` from `devServer`
-  if (!options.hotOnly) {
-    options.hotOnly = argv.hotOnly;
+    options.hot = argv.hotOnly ? 'only' : argv.hot;
   }
 
   // TODO https://github.com/webpack/webpack-dev-server/issues/616 (v4)
diff --git a/lib/utils/updateCompiler.js b/lib/utils/updateCompiler.js
@@ -57,7 +57,7 @@ function updateCompiler(compiler, options) {
     });
 
     // do not apply the plugin unless it didn't exist before.
-    if (options.hot || options.hotOnly) {
+    if (options.hot) {
       compilersWithoutHMR.forEach((compiler) => {
         // addDevServerEntrypoints above should have added the plugin
         // to the compiler options
diff --git a/test/__snapshots__/validate-options.test.js.snap b/test/__snapshots__/validate-options.test.js.snap
@@ -131,12 +131,11 @@ exports[`options should throw an error on the "host" option with "false" value 1
 
 exports[`options should throw an error on the "hot" option with "" value 1`] = `
 "Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.hot should be a boolean."
-`;
-
-exports[`options should throw an error on the "hotOnly" option with "" value 1`] = `
-"Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.hotOnly should be a boolean."
+ - options.hot should be one of these:
+   boolean | \\"only\\"
+   Details:
+    * options.hot should be a boolean.
+    * options.hot should be \\"only\\"."
 `;
 
 exports[`options should throw an error on the "http2" option with "" value 1`] = `
diff --git a/test/fixtures/schema/webpack.config.no-dev-stats.js b/test/fixtures/schema/webpack.config.no-dev-stats.js
@@ -13,7 +13,6 @@ module.exports = {
     publicPath: '_publicPath',
     filename: '_filename',
     hot: '_hot',
-    hotOnly: '_hotOnly',
     clientLogLevel: '_clientLogLevel',
     contentBase: '_contentBase',
     watchContentBase: '_watchContentBase',
diff --git a/test/helpers/test-server.js b/test/helpers/test-server.js
@@ -23,7 +23,6 @@ function startFullSetup(config, options, done) {
   if (
     options.inline === undefined &&
     options.hot === undefined &&
-    options.hotOnly === undefined &&
     options.liveReload === undefined
   ) {
     options.inline = false;
diff --git a/test/ports-map.js b/test/ports-map.js
@@ -21,7 +21,6 @@ const portsList = {
   'historyApiFallback-option': 1,
   'host-option': 1,
   'hot-option': 1,
-  'hotOnly-option': 1,
   'http2-option': 1,
   'https-option': 1,
   'inline-option': 1,
diff --git a/test/server/Server.test.js b/test/server/Server.test.js
@@ -51,12 +51,12 @@ describe('Server', () => {
       compiler.run(() => {});
     });
 
-    it('add hotOnly option', (done) => {
+    it('add hot with the "only" value option', (done) => {
       const compiler = webpack(config);
       const server = new Server(
         compiler,
         Object.assign({}, baseDevConfig, {
-          hotOnly: true,
+          hot: 'only',
         })
       );
 
diff --git a/test/server/__snapshots__/Server.test.js.snap b/test/server/__snapshots__/Server.test.js.snap
@@ -19,7 +19,7 @@ Array [
 ]
 `;
 
-exports[`Server addEntries add hotOnly option 1`] = `
+exports[`Server addEntries add hot with the "only" value option 1`] = `
 Array [
   Array [
     "client",
diff --git a/test/server/hot-option.test.js b/test/server/hot-option.test.js
@@ -183,4 +183,63 @@ describe('hot option', () => {
 
     afterAll(testServer.close);
   });
+
+  describe('simple hot only config entries', () => {
+    beforeAll((done) => {
+      const options = {
+        port,
+        inline: true,
+        hot: 'only',
+        watchOptions: {
+          poll: true,
+        },
+      };
+      server = testServer.startAwaitingCompilation(config, options, done);
+      req = request(server.app);
+    });
+
+    afterAll(testServer.close);
+
+    it('should include hot only script in the bundle', async () => {
+      await req
+        .get('/main.js')
+        .expect(200, /webpack\/hot\/only-dev-server\.js/);
+    });
+  });
+
+  describe('simple hot only config HMR plugin', () => {
+    it('should register the HMR plugin before compilation is complete', (done) => {
+      let pluginFound = false;
+
+      const options = {
+        port,
+        inline: true,
+        hot: 'only',
+        watchOptions: {
+          poll: true,
+        },
+      };
+      const fullSetup = testServer.startAwaitingCompilationFullSetup(
+        config,
+        options,
+        () => {
+          expect(pluginFound).toBeTruthy();
+          done();
+        }
+      );
+
+      const compiler = fullSetup.compiler;
+
+      compiler.hooks.compilation.intercept({
+        register: (tapInfo) => {
+          if (tapInfo.name === 'HotModuleReplacementPlugin') {
+            pluginFound = true;
+          }
+          return tapInfo;
+        },
+      });
+    });
+
+    afterAll(testServer.close);
+  });
 });
diff --git a/test/server/hotOnly-option.test.js b/test/server/hotOnly-option.test.js
diff --git a/test/server/open-option.test.js b/test/server/open-option.test.js
@@ -27,7 +27,7 @@ describe('open option', () => {
       server.close(() => {
         expect(open.mock.calls[0]).toMatchInlineSnapshot(`
           Array [
-            "http://localhost:8120/",
+            "http://localhost:8119/",
             Object {
               "wait": false,
             },
diff --git a/test/server/utils/__snapshots__/createConfig.test.js.snap b/test/server/utils/__snapshots__/createConfig.test.js.snap
diff --git a/test/server/utils/addEntries.test.js b/test/server/utils/addEntries.test.js
diff --git a/test/server/utils/createConfig.test.js b/test/server/utils/createConfig.test.js
diff --git a/test/validate-options.test.js b/test/validate-options.test.js
