Merge branch 'master' into issue-3351

Author: alexander-akait

bin/cli-flags.js

@@ -30,12 +30,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          "Clear all items provided in configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts",
+          "Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts",
         path: 'allowedHosts',
       },
     ],
     description:
-      "Clear all items provided in configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts",
+      "Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -614,12 +614,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          'Clear all items provided in configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen',
+          "Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen",
         path: 'open',
       },
     ],
     description:
-      'Clear all items provided in configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen',
+      "Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -629,12 +629,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          'Clear all items provided in configuration. Opens specified page in browser.',
+          "Clear all items provided in 'open.target' configuration. Opens specified page in browser.",
         path: 'open.target',
       },
     ],
     description:
-      'Clear all items provided in configuration. Opens specified page in browser.',
+      "Clear all items provided in 'open.target' configuration. Opens specified page in browser.",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -644,12 +644,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          'Clear all items provided in configuration. Open specified browser.',
+          "Clear all items provided in 'open.app.name' configuration. Open specified browser.",
         path: 'open.app.name',
       },
     ],
     description:
-      'Clear all items provided in configuration. Open specified browser.',
+      "Clear all items provided in 'open.app.name' configuration. Open specified browser.",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -776,12 +776,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          "Clear all items provided in configuration. Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic",
+          "Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic",
         path: 'static',
       },
     ],
     description:
-      "Clear all items provided in configuration. Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic",
+      "Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -791,12 +791,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          'Clear all items provided in configuration. The static files will be available in the browser under this public path.',
+          "Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.",
         path: 'static.publicPath',
       },
     ],
     description:
-      'Clear all items provided in configuration. The static files will be available in the browser under this public path.',
+      "Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.",
     simpleType: 'boolean',
     multiple: false,
   },
@@ -821,12 +821,12 @@ module.exports = {
         type: 'reset',
         multiple: false,
         description:
-          'Clear all items provided in configuration. Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles',
+          "Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles",
         path: 'watchFiles',
       },
     ],
     description:
-      'Clear all items provided in configuration. Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles',
+      "Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles",
     simpleType: 'boolean',
     multiple: false,
   },

lib/utils/normalizeOptions.js

@@ -25,92 +25,18 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
     watch: watchOptions,
   };
 
-  if (typeof options.static === 'undefined') {
-    options.static = [defaultOptionsForStatic];
-  } else if (typeof options.static === 'boolean') {
-    options.static = options.static ? [defaultOptionsForStatic] : false;
-  } else if (typeof options.static === 'string') {
-    options.static = [
-      { ...defaultOptionsForStatic, directory: options.static },
-    ];
-  } else if (Array.isArray(options.static)) {
-    options.static = options.static.map((item) => {
-      if (typeof item === 'string') {
-        return { ...defaultOptionsForStatic, directory: item };
-      }
-
-      return { ...defaultOptionsForStatic, ...item };
-    });
-  } else {
-    options.static = [{ ...defaultOptionsForStatic, ...options.static }];
-  }
-
-  if (options.static) {
-    const isAbsoluteUrl = require('is-absolute-url');
-
-    options.static.forEach((staticOption) => {
-      if (isAbsoluteUrl(staticOption.directory)) {
-        throw new Error('Using a URL as static.directory is not supported');
-      }
-
-      // ensure that publicPath is an array
-      if (typeof staticOption.publicPath === 'string') {
-        staticOption.publicPath = [staticOption.publicPath];
-      }
-
-      // ensure that watch is an object if true
-      if (staticOption.watch === true) {
-        staticOption.watch = defaultOptionsForStatic.watch;
-      }
-
-      // ensure that serveIndex is an object if true
-      if (staticOption.serveIndex === true) {
-        staticOption.serveIndex = defaultOptionsForStatic.serveIndex;
-      }
-    });
-  }
-
-  options.hot =
-    typeof options.hot === 'boolean' || options.hot === 'only'
-      ? options.hot
-      : true;
-  options.liveReload =
-    typeof options.liveReload !== 'undefined' ? options.liveReload : true;
-
-  if (typeof options.port === 'string' && options.port !== 'auto') {
-    options.port = Number(options.port);
+  if (typeof options.allowedHosts === 'undefined') {
+    // allowedHosts allows some default hosts picked from
+    // `options.host` or `webSocketURL.hostname` and `localhost`
+    options.allowedHosts = 'auto';
   }
-
-  const defaultWebSocketServerType = 'ws';
-  const defaultWebSocketServerOptions = { path: '/ws' };
-
-  if (typeof options.webSocketServer === 'undefined') {
-    options.webSocketServer = {
-      type: defaultWebSocketServerType,
-      options: defaultWebSocketServerOptions,
-    };
-  } else if (
-    typeof options.webSocketServer === 'string' ||
-    typeof options.webSocketServer === 'function'
+  if (
+    typeof options.allowedHosts === 'string' &&
+    options.allowedHosts !== 'auto' &&
+    options.allowedHosts !== 'all'
   ) {
-    options.webSocketServer = {
-      type: options.webSocketServer,
-      options: defaultWebSocketServerOptions,
-    };
-  } else {
-    options.webSocketServer = {
-      type: options.webSocketServer.type || defaultWebSocketServerType,
-      options: {
-        ...defaultWebSocketServerOptions,
-        ...options.webSocketServer.options,
-      },
-    };
-
-    if (typeof options.webSocketServer.options.port === 'string') {
-      options.webSocketServer.options.port = Number(
-        options.webSocketServer.options.port
-      );
-    }
+    // we store allowedHosts as array when supplied as string
+    options.allowedHosts = [options.allowedHosts];
   }
 
   if (!options.client) {
@@ -150,30 +76,17 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
     options.client.hotEntry = options.hot;
   }
 
-  options.devMiddleware = options.devMiddleware || {};
-
-  if (typeof options.allowedHosts === 'undefined') {
-    // allowedHosts allows some default hosts picked from
-    // `options.host` or `webSocketURL.hostname` and `localhost`
-    options.allowedHosts = 'auto';
-  }
-  if (
-    typeof options.allowedHosts === 'string' &&
-    options.allowedHosts !== 'auto' &&
-    options.allowedHosts !== 'all'
-  ) {
-    // we store allowedHosts as array when supplied as string
-    options.allowedHosts = [options.allowedHosts];
-  }
-
-  if (typeof options.setupExitSignals === 'undefined') {
-    options.setupExitSignals = true;
-  }
-
   if (typeof options.compress === 'undefined') {
     options.compress = true;
   }
 
+  options.devMiddleware = options.devMiddleware || {};
+
+  options.hot =
+    typeof options.hot === 'boolean' || options.hot === 'only'
+      ? options.hot
+      : true;
+
   // if the user enables http2, we can safely enable https
   if ((options.http2 && !options.https) || options.https === true) {
     options.https = {
@@ -306,6 +219,13 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
     options.https.cert = options.https.cert || fakeCert;
   }
 
+  options.liveReload =
+    typeof options.liveReload !== 'undefined' ? options.liveReload : true;
+
+  if (typeof options.port === 'string' && options.port !== 'auto') {
+    options.port = Number(options.port);
+  }
+
   /**
    * Assume a proxy configuration specified as:
    * proxy: {
@@ -373,6 +293,87 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
       }
     }
   }
+
+  if (typeof options.setupExitSignals === 'undefined') {
+    options.setupExitSignals = true;
+  }
+
+  if (typeof options.static === 'undefined') {
+    options.static = [defaultOptionsForStatic];
+  } else if (typeof options.static === 'boolean') {
+    options.static = options.static ? [defaultOptionsForStatic] : false;
+  } else if (typeof options.static === 'string') {
+    options.static = [
+      { ...defaultOptionsForStatic, directory: options.static },
+    ];
+  } else if (Array.isArray(options.static)) {
+    options.static = options.static.map((item) => {
+      if (typeof item === 'string') {
+        return { ...defaultOptionsForStatic, directory: item };
+      }
+
+      return { ...defaultOptionsForStatic, ...item };
+    });
+  } else {
+    options.static = [{ ...defaultOptionsForStatic, ...options.static }];
+  }
+
+  if (options.static) {
+    const isAbsoluteUrl = require('is-absolute-url');
+
+    options.static.forEach((staticOption) => {
+      if (isAbsoluteUrl(staticOption.directory)) {
+        throw new Error('Using a URL as static.directory is not supported');
+      }
+
+      // ensure that publicPath is an array
+      if (typeof staticOption.publicPath === 'string') {
+        staticOption.publicPath = [staticOption.publicPath];
+      }
+
+      // ensure that watch is an object if true
+      if (staticOption.watch === true) {
+        staticOption.watch = defaultOptionsForStatic.watch;
+      }
+
+      // ensure that serveIndex is an object if true
+      if (staticOption.serveIndex === true) {
+        staticOption.serveIndex = defaultOptionsForStatic.serveIndex;
+      }
+    });
+  }
+
+  const defaultWebSocketServerType = 'ws';
+  const defaultWebSocketServerOptions = { path: '/ws' };
+
+  if (typeof options.webSocketServer === 'undefined') {
+    options.webSocketServer = {
+      type: defaultWebSocketServerType,
+      options: defaultWebSocketServerOptions,
+    };
+  } else if (
+    typeof options.webSocketServer === 'string' ||
+    typeof options.webSocketServer === 'function'
+  ) {
+    options.webSocketServer = {
+      type: options.webSocketServer,
+      options: defaultWebSocketServerOptions,
+    };
+  } else {
+    options.webSocketServer = {
+      type: options.webSocketServer.type || defaultWebSocketServerType,
+      options: {
+        ...defaultWebSocketServerOptions,
+        ...options.webSocketServer.options,
+      },
+    };
+
+    if (typeof options.webSocketServer.options.port === 'string') {
+      options.webSocketServer.options.port = Number(
+        options.webSocketServer.options.port
+      );
+    }
+  }
 }
 
 module.exports = normalizeOptions;