feat: allow to set false for dev server

webpack · Jan 23, 2024 · 2d6f5fa · 2d6f5fa
2 parents 81623b6 + 818b8ec
commit 2d6f5fa
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 19 deletions.
diff --git a/declarations/WebpackOptions.d.ts b/declarations/WebpackOptions.d.ts
@@ -35,6 +35,14 @@ export type Context = string;
  * References to other configurations to depend on.
  */
 export type Dependencies = string[];
+/**
+ * Options for the webpack-dev-server.
+ */
+export type DevServer =
+	| false
+	| {
+			[k: string]: any;
+	  };
 /**
  * A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).
  */
@@ -1055,12 +1063,6 @@ export interface FileCacheOptions {
 	 */
 	version?: string;
 }
-/**
- * Options for the webpack-dev-server.
- */
-export interface DevServer {
-	[k: string]: any;
-}
 /**
  * Multiple entry bundles are created. The key is the entry name. The value can be a string, an array or an entry description object.
  */

diff --git a/lib/config/normalization.js b/lib/config/normalization.js
@@ -175,9 +175,10 @@ const getNormalizedWebpackOptions = config => {
 			),
 		context: config.context,
 		dependencies: config.dependencies,
-		devServer: optionalNestedConfig(config.devServer, devServer => ({
-			...devServer
-		})),
+		devServer: optionalNestedConfig(config.devServer, devServer => {
+			if (devServer === false) return false;
+			return { ...devServer };
+		}),
 		devtool: config.devtool,
 		entry:
 			config.entry === undefined

diff --git a/schemas/WebpackOptions.check.js b/schemas/WebpackOptions.check.js
diff --git a/schemas/WebpackOptions.json b/schemas/WebpackOptions.json
@@ -473,7 +473,16 @@
     },
     "DevServer": {
       "description": "Options for the webpack-dev-server.",
-      "type": "object"
+      "anyOf": [
+        {
+          "description": "Disable dev server.",
+          "enum": [false]
+        },
+        {
+          "description": "Options for the webpack-dev-server.",
+          "type": "object"
+        }
+      ]
     },
     "DevTool": {
       "description": "A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).",

diff --git a/test/__snapshots__/Cli.basictest.js.snap b/test/__snapshots__/Cli.basictest.js.snap
@@ -426,6 +426,22 @@ Object {
     "multiple": false,
     "simpleType": "boolean",
   },
+  "dev-server": Object {
+    "configs": Array [
+      Object {
+        "description": "Disable dev server.",
+        "multiple": false,
+        "path": "devServer",
+        "type": "enum",
+        "values": Array [
+          false,
+        ],
+      },
+    ],
+    "description": "Disable dev server.",
+    "multiple": false,
+    "simpleType": "boolean",
+  },
   "devtool": Object {
     "configs": Array [
       Object {

diff --git a/types.d.ts b/types.d.ts
@@ -3240,13 +3240,6 @@ declare interface DeterministicModuleIdsPluginOptions {
 	 */
 	failOnConflict?: boolean;
 }
-
-/**
- * Options for the webpack-dev-server.
- */
-declare interface DevServer {
-	[index: string]: any;
-}
 declare class DllPlugin {
 	constructor(options: DllPluginOptions);
 	options: {
@@ -13447,7 +13440,7 @@ declare interface WebpackOptionsNormalized {
 	/**
 	 * Options for the webpack-dev-server.
 	 */
-	devServer?: DevServer;
+	devServer?: false | { [index: string]: any };
 
 	/**
 	 * A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).