feat: add basic implementation

Author: chenjiahan

.github/workflows/test.yml

@@ -5,10 +5,8 @@ on:
   # Triggers the workflow on pull request events but only for the main branch
   pull_request:
     branches: [main]
-
   push:
     branches: [main]
-
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

README.md

@@ -1,10 +1,10 @@
-# rsbuild-plugin-example
+# @rsbuild/plugin-toml
 
-rsbuild-plugin-example is a Rsbuild plugin to do something.
+An Rsbuild plugin to import TOML files and convert them to JavaScript objects.
 
 <p>
-  <a href="https://npmjs.com/package/rsbuild-plugin-example">
-   <img src="https://img.shields.io/npm/v/rsbuild-plugin-example?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  <a href="https://npmjs.com/package/@rsbuild/plugin-toml">
+   <img src="https://img.shields.io/npm/v/@rsbuild/plugin-toml?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
   </a>
   <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
@@ -14,36 +14,20 @@ rsbuild-plugin-example is a Rsbuild plugin to do something.
 Install:
 
 ```bash
-npm add rsbuild-plugin-example -D
+npm add @rsbuild/plugin-toml -D
 ```
 
 Add plugin to your `rsbuild.config.ts`:
 
 ```ts
 // rsbuild.config.ts
-import { pluginExample } from "rsbuild-plugin-example";
+import { pluginToml } from "@rsbuild/plugin-toml";
 
 export default {
-  plugins: [pluginExample()],
+  plugins: [pluginToml()],
 };
 ```
 
-## Options
-
-### foo
-
-Some description.
-
-- Type: `string`
-- Default: `undefined`
-- Example:
-
-```js
-pluginExample({
-  foo: "bar",
-});
-```
-
 ## License
 
 [MIT](./LICENSE).

package.json

@@ -1,5 +1,5 @@
 {
-	"name": "rsbuild-plugin-example",
+	"name": "@rsbuild/plugin-toml",
 	"version": "0.0.0",
 	"repository": "https://github.com/rspack-contrib/rsbuild-plugin-template",
 	"license": "MIT",
@@ -14,7 +14,9 @@
 	"main": "./dist/index.js",
 	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.ts",
-	"files": ["dist"],
+	"files": [
+		"dist"
+	],
 	"scripts": {
 		"build": "tsup",
 		"dev": "tsup --watch",
@@ -32,6 +34,9 @@
 			"biome check --write --no-errors-on-unmatched"
 		]
 	},
+	"dependencies": {
+		"toml": "^3.0.0"
+	},
 	"devDependencies": {
 		"@biomejs/biome": "^1.8.3",
 		"@playwright/test": "^1.44.1",

playground/rsbuild.config.ts

@@ -1,6 +1,6 @@
 import { defineConfig } from '@rsbuild/core';
-import { pluginExample } from '../src';
+import { pluginToml } from '../src';
 
 export default defineConfig({
-	plugins: [pluginExample()],
+	plugins: [pluginToml()],
 });

playground/src/a.toml

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

playground/src/b.toml

@@ -0,0 +1 @@
+list =  [1, 2]

playground/src/index.css

@@ -1,8 +1,7 @@
-import './index.css';
+import { age } from './a.toml';
+import b from './b.toml';
 
-document.querySelector('#root').innerHTML = `
-<div class="content">
-  <h1>Vanilla Rsbuild</h1>
-  <p>Start building amazing things with Rsbuild.</p>
-</div>
-`;
+window.age = age;
+window.b = JSON.stringify(b);
+
+console.log(age, b);

playground/src/index.js

@@ -1,16 +1,16 @@
 import type { RsbuildPlugin } from '@rsbuild/core';
 
-export type PluginExampleOptions = {
-	foo?: string;
-	bar?: boolean;
-};
+export const PLUGIN_TOML_NAME = 'rsbuild:toml';
 
-export const pluginExample = (
-	options: PluginExampleOptions = {},
-): RsbuildPlugin => ({
-	name: 'plugin-example',
+export const pluginToml = (): RsbuildPlugin => ({
+	name: PLUGIN_TOML_NAME,
 
-	setup() {
-		console.log('Hello Rsbuild!', options);
+	async setup(api) {
+		const { parse } = await import('toml');
+
+		api.transform({ test: /\.toml$/ }, ({ code }) => {
+			const parsed = parse(code);
+			return `module.exports = ${JSON.stringify(parsed, undefined, '\t')};`;
+		});
 	},
 });