feat(cli): defineConfig support all types

packages/rspack-cli/src/bootstrap.ts

@@ -1,4 +1,4 @@
-import { RspackCLI } from "./rspack-cli";
+import { RspackCLI } from "./cli";
 
 export async function runCLI(argv: string[]) {
 	const cli = new RspackCLI();

packages/rspack-cli/src/rspack-cli.ts → packages/rspack-cli/src/cli.ts

@@ -286,7 +286,32 @@ export class RspackCLI {
 	}
 }
 
-export function defineConfig(config: RspackOptions): RspackOptions {
+export type RspackConfigFn = (
+	env: Record<string, any>,
+	argv: Record<string, any>
+) => RspackOptions | MultiRspackOptions;
+
+export type RspackConfigAsyncFn = (
+	env: Record<string, any>,
+	argv: Record<string, any>
+) => Promise<RspackOptions | MultiRspackOptions>;
+
+export type RspackConfigExport =
+	| RspackOptions
+	| MultiRspackOptions
+	| RspackConfigFn
+	| RspackConfigAsyncFn;
+
+/**
+ * This function helps you to autocomplete configuration types.
+ * It accepts a Rspack config object, or a function that returns a config.
+ */
+export function defineConfig(config: RspackOptions): RspackOptions;
+export function defineConfig(config: MultiRspackOptions): MultiRspackOptions;
+export function defineConfig(config: RspackConfigFn): RspackConfigFn;
+export function defineConfig(config: RspackConfigAsyncFn): RspackConfigAsyncFn;
+export function defineConfig(config: RspackConfigExport): RspackConfigExport;
+export function defineConfig(config: RspackConfigExport) {
 	return config;
 }
 

packages/rspack-cli/src/commands/build.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs";
 import { MultiStats, Stats } from "@rspack/core";
 
-import type { RspackCLI } from "../rspack-cli";
+import type { RspackCLI } from "../cli";
 import { RspackCommand } from "../types";
 import {
 	commonOptions,

packages/rspack-cli/src/commands/preview.ts

@@ -6,7 +6,7 @@ import {
 	rspack
 } from "@rspack/core";
 
-import type { RspackCLI } from "../rspack-cli";
+import type { RspackCLI } from "../cli";
 import { RspackCommand, RspackPreviewCLIOptions } from "../types";
 import { previewOptions } from "../utils/options";
 

packages/rspack-cli/src/commands/serve.ts

@@ -1,7 +1,7 @@
 import { Compiler, DevServer } from "@rspack/core";
 import type { RspackDevServer as RspackDevServerType } from "@rspack/dev-server";
 
-import type { RspackCLI } from "../rspack-cli";
+import type { RspackCLI } from "../cli";
 import { RspackCommand } from "../types";
 import {
 	commonOptions,

packages/rspack-cli/src/index.ts

@@ -1,2 +1,2 @@
-export { defineConfig, definePlugin, RspackCLI } from "./rspack-cli";
+export { defineConfig, definePlugin, RspackCLI } from "./cli";
 export * from "./types";

packages/rspack-cli/src/types.ts

@@ -1,7 +1,7 @@
 import type { DevServer } from "@rspack/core";
 import { Colorette } from "colorette";
 
-import { RspackCLI } from "./rspack-cli";
+import { RspackCLI } from "./cli";
 export type { Configuration } from "@rspack/core";
 
 export interface IRspackCLI {

packages/rspack-cli/tests/build/basic/basic.test.ts

@@ -80,38 +80,44 @@ describe("build command", () => {
 		expect(mainJs).toContain("other");
 		expect(mainJs).not.toContain("CONFIG");
 	});
-	it.each(["-o", "--output-path"])("output-path option %p should have higher priority than config", async (command) => {
-		const { exitCode, stderr, stdout } = await run(__dirname, [
-			command,
-			"public",
-			"--config",
-			"./entry.config.js"
-		]);
-		const mainJs = await readFile(
-			resolve(__dirname, "public/main.js"),
-			"utf-8"
-		);
+	it.each(["-o", "--output-path"])(
+		"output-path option %p should have higher priority than config",
+		async command => {
+			const { exitCode, stderr, stdout } = await run(__dirname, [
+				command,
+				"dist/public",
+				"--config",
+				"./entry.config.js"
+			]);
+			const mainJs = await readFile(
+				resolve(__dirname, "dist/public/main.js"),
+				"utf-8"
+			);
 
-		expect(exitCode).toBe(0);
-		expect(stderr).toBeFalsy();
-		expect(stdout).toBeTruthy();
-		expect(mainJs).toContain("CONFIG");
-	});
+			expect(exitCode).toBe(0);
+			expect(stderr).toBeFalsy();
+			expect(stdout).toBeTruthy();
+			expect(mainJs).toContain("CONFIG");
+		}
+	);
 
-	it.each(["-d", "--devtool"])("devtool option %p should have higher priority than config", async (command) => {
-		const { exitCode, stderr, stdout } = await run(__dirname, [
-			command,
-			"--config",
-			"./entry.config.js"
-		]);
-		const mainJs = await readFile(
-			resolve(__dirname, "public/main.js"),
-			"utf-8"
-		);
+	it.each(["-d", "--devtool"])(
+		"devtool option %p should have higher priority than config",
+		async command => {
+			const { exitCode, stderr, stdout } = await run(__dirname, [
+				command,
+				"--config",
+				"./entry.config.js"
+			]);
+			const mainJs = await readFile(
+				resolve(__dirname, "dist/public/main.js"),
+				"utf-8"
+			);
 
-		expect(exitCode).toBe(0);
-		expect(stderr).toBeFalsy();
-		expect(stdout).toBeTruthy();
-		expect(mainJs).toContain("CONFIG");
-	});
+			expect(exitCode).toBe(0);
+			expect(stderr).toBeFalsy();
+			expect(stdout).toBeTruthy();
+			expect(mainJs).toContain("CONFIG");
+		}
+	);
 });

packages/rspack-cli/tests/build/config/config.test.ts

@@ -152,20 +152,47 @@ describe("rspack cli", () => {
 		});
 	});
 
-	describe("should load moonrepo config", () => {
-		const cwd = resolve(__dirname, "./moonrepo");
-		it("should load moonrepo config.ts file", async () => {
+	describe("should load config with defineConfig helper", () => {
+		const cwd = resolve(__dirname, "./esm");
+
+		it("should load config.ts file", async () => {
+			const { exitCode, stdout } = await run(cwd, ["-c", "rspack.config.ts"], {
+				nodeOptions: ["--experimental-loader=ts-node/esm"]
+			});
+			expect(stdout).toBeTruthy();
+			expect(exitCode).toBe(0);
+			expect(
+				readFile(resolve(cwd, "./dist/ts.bundle.js"), { encoding: "utf-8" })
+			).resolves.toMatch(/Main esm file/);
+		});
+
+		it("should load config.mts file", async () => {
+			const { exitCode, stdout } = await run(cwd, ["-c", "rspack.config.mts"], {
+				nodeOptions: ["--experimental-loader=ts-node/esm"]
+			});
+
+			expect(stdout).toBeTruthy();
+			expect(exitCode).toBe(0);
+			expect(
+				readFile(resolve(cwd, "./dist/mts.bundle.js"), { encoding: "utf-8" })
+			).resolves.toMatch(/Main esm file/);
+		});
+	});
+
+	describe("should load monorepo config", () => {
+		const cwd = resolve(__dirname, "./monorepo");
+		it("should load monorepo config.ts file", async () => {
 			const { exitCode, stdout } = await run(cwd, ["-c", "rspack.config.ts"], {
 				nodeOptions: ["--experimental-loader=ts-node/esm"]
 			});
 			expect(stdout).toBeTruthy();
 			expect(exitCode).toBe(0);
 			expect(
 				readFile(
-					resolve(cwd, `./dist/moonrepo.bundle.depsA.1.0.0-depsB.2.0.0.js`),
+					resolve(cwd, `./dist/monorepo.bundle.depsA.1.0.0-depsB.2.0.0.js`),
 					{ encoding: "utf-8" }
 				)
-			).resolves.toMatch(/Main moonrepo file/);
+			).resolves.toMatch(/Main monorepo file/);
 		});
 	});
 });

packages/rspack-cli/tests/build/config/define-config/main.ts

@@ -0,0 +1 @@
+console.log("Main esm file");

packages/rspack-cli/tests/build/config/define-config/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

packages/rspack-cli/tests/build/config/define-config/rspack.config.mts

@@ -0,0 +1,16 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "@rspack/cli";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig(env => {
+	return {
+		mode: env.RSPACK_BUILD ? "production" : "development",
+		entry: path.resolve(__dirname, "main.ts"),
+		output: {
+			path: path.resolve(__dirname, "dist"),
+			filename: "mts.bundle.js"
+		}
+	};
+});

packages/rspack-cli/tests/build/config/define-config/rspack.config.ts

@@ -0,0 +1,16 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "@rspack/cli";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default defineConfig([
+	{
+		mode: "production",
+		entry: path.resolve(__dirname, "main.ts"),
+		output: {
+			path: path.resolve(__dirname, "dist"),
+			filename: "ts.bundle.js"
+		}
+	}
+]);

packages/rspack-cli/tests/build/config/define-config/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "target": "ESNext",
+    "module": "NodeNext",
+    "noEmit": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "nodenext",
+    "allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["**/*.ts", "**/*.js", "rspack.config.mts"]
+}

packages/rspack-cli/tests/build/config/esm/tsconfig.json

@@ -3,13 +3,13 @@
     "baseUrl": ".",
     "rootDir": ".",
     "target": "ESNext",
-    "module": "ESNext",
-    "noEmit":true,
+    "module": "NodeNext",
+    "noEmit": true,
     "esModuleInterop": true,
-    "resolveJsonModule":true,
+    "resolveJsonModule": true,
     "moduleResolution": "nodenext",
     "allowImportingTsExtensions": true,
-    "allowSyntheticDefaultImports": true,
+    "allowSyntheticDefaultImports": true
   },
   "include": ["**/*.ts", "**/*.js"]
 }

packages/rspack-cli/tests/build/config/monorepo/main.ts

@@ -0,0 +1 @@
+console.log("Main monorepo file");

packages/rspack-cli/tests/build/config/moonrepo/rspack.config.ts → packages/rspack-cli/tests/build/config/monorepo/rspack.config.ts

@@ -13,6 +13,6 @@ export default {
 	entry: path.resolve(__dirname, "main.ts"),
 	output: {
 		path: path.resolve(__dirname, "dist"),
-		filename: `moonrepo.bundle.depsA.${packageA_deps.version}-depsB.${packageB_deps.version}.js`
+		filename: `monorepo.bundle.depsA.${packageA_deps.version}-depsB.${packageB_deps.version}.js`
 	}
 };

packages/rspack-cli/tests/build/config/moonrepo/tsconfig.json → packages/rspack-cli/tests/build/config/monorepo/tsconfig.json

@@ -3,12 +3,12 @@
     "baseUrl": ".",
     "rootDir": ".",
     "target": "ESNext",
-    "module": "ESNext",
-    "noEmit":true,
-    "resolveJsonModule":true,
+    "module": "NodeNext",
+    "noEmit": true,
+    "resolveJsonModule": true,
     "moduleResolution": "nodenext",
     "allowImportingTsExtensions": true,
-    "allowSyntheticDefaultImports": true,
+    "allowSyntheticDefaultImports": true
   },
   "include": ["**/*.ts", "**/*.js"]
 }