feat: add esModule option

Author: chenjiahan

README.md

@@ -50,6 +50,22 @@ console.log(example.hello); // 'world';
 console.log(example.foo); // { bar: 'baz' };
 ```
 
+## Options
+
+### esModule
+
+By default, `@rsbuild/plugin-toml` generates JS modules that use the ES modules syntax. If you want to generate a CommonJS module, you can set the `esModule` option to `false`.
+
+- Type: `boolean`
+- Default: `true`
+- Example:
+
+```js
+pluginToml({
+  exModule: false,
+});
+```
+
 ## Type Declaration
 
 When you import TOML files in TypeScript code, please create a `src/env.d.ts` file in your project and add the type declarations.

playground/src/a.toml

@@ -1,2 +1 @@
-foo = "bar"
-age = 1
+list =  [1, 2]

playground/src/index.js

@@ -1,7 +1,5 @@
-import { age } from './a.toml';
-import b from './b.toml';
+import a from './a.toml';
 
-window.age = age;
-window.b = JSON.stringify(b);
+window.a = JSON.stringify(a);
 
-console.log(age, b);
+console.log(a);

src/index.ts

@@ -2,15 +2,21 @@ import type { RsbuildPlugin } from '@rsbuild/core';
 
 export const PLUGIN_TOML_NAME = 'rsbuild:toml';
 
-export const pluginToml = (): RsbuildPlugin => ({
+export type PluginTomlOptions = {
+	esModule?: boolean;
+};
+
+export const pluginToml = (options: PluginTomlOptions = {}): RsbuildPlugin => ({
 	name: PLUGIN_TOML_NAME,
 
 	async setup(api) {
 		const { parse } = await import('toml');
+		const { esModule } = options;
 
 		api.transform({ test: /\.toml$/ }, ({ code }) => {
 			const parsed = parse(code);
-			return `module.exports = ${JSON.stringify(parsed, undefined, '\t')};`;
+			const exportType = esModule ? 'export default' : 'module.exports =';
+			return `${exportType} ${JSON.stringify(parsed, undefined, '\t')};`;
 		});
 	},
 });

test/basic/index.test.ts

@@ -11,14 +11,16 @@ test('should render page as expected', async ({ page }) => {
 		cwd: __dirname,
 		rsbuildConfig: {
 			plugins: [pluginToml()],
+			server: {
+				port: 3100,
+			},
 		},
 	});
 
 	const { server, urls } = await rsbuild.startDevServer();
 
 	await page.goto(urls[0]);
-	expect(await page.evaluate('window.age')).toBe(1);
-	expect(await page.evaluate('window.b')).toBe('{"list":[1,2]}');
+	expect(await page.evaluate('window.a')).toBe('{"list":[1,2]}');
 
 	await server.close();
 });
@@ -28,15 +30,17 @@ test('should build succeed', async ({ page }) => {
 		cwd: __dirname,
 		rsbuildConfig: {
 			plugins: [pluginToml()],
+			server: {
+				port: 3100,
+			},
 		},
 	});
 
 	await rsbuild.build();
 	const { server, urls } = await rsbuild.preview();
 
 	await page.goto(urls[0]);
-	expect(await page.evaluate('window.age')).toBe(1);
-	expect(await page.evaluate('window.b')).toBe('{"list":[1,2]}');
+	expect(await page.evaluate('window.a')).toBe('{"list":[1,2]}');
 
 	await server.close();
 });

test/basic/src/a.toml

@@ -1,2 +1 @@
-foo = "bar"
-age = 1
+list =  [1, 2]

test/basic/src/b.toml

@@ -1,7 +1,3 @@
-import { age } from './a.toml';
-import b from './b.toml';
+import a from './a.toml';
 
-window.age = age;
-window.b = JSON.stringify(b);
-
-console.log(age, b);
+window.a = JSON.stringify(a);

test/basic/src/index.js

@@ -0,0 +1,50 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { expect, test } from '@playwright/test';
+import { createRsbuild } from '@rsbuild/core';
+import { pluginToml } from '../../src';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+test('should render page as expected', async ({ page }) => {
+	const rsbuild = await createRsbuild({
+		cwd: __dirname,
+		rsbuildConfig: {
+			plugins: [
+				pluginToml({
+					esModule: false,
+				}),
+			],
+		},
+	});
+
+	const { server, urls } = await rsbuild.startDevServer();
+
+	await page.goto(urls[0]);
+	expect(await page.evaluate('window.age')).toBe(1);
+	expect(await page.evaluate('window.b')).toBe('{"list":[1,2]}');
+
+	await server.close();
+});
+
+test('should build succeed', async ({ page }) => {
+	const rsbuild = await createRsbuild({
+		cwd: __dirname,
+		rsbuildConfig: {
+			plugins: [
+				pluginToml({
+					esModule: false,
+				}),
+			],
+		},
+	});
+
+	await rsbuild.build();
+	const { server, urls } = await rsbuild.preview();
+
+	await page.goto(urls[0]);
+	expect(await page.evaluate('window.age')).toBe(1);
+	expect(await page.evaluate('window.b')).toBe('{"list":[1,2]}');
+
+	await server.close();
+});

test/commonjs/index.test.ts

@@ -0,0 +1,2 @@
+foo = "bar"
+age = 1