@rsbuild/plugin-toml 0.7.10 → 1.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+Copyright (c) 2024 Rspack Contrib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,19 +1,82 @@
-<p align="center">
-  <a href="https://rsbuild.dev" target="blank"><img src="https://github.com/web-infra-dev/rsbuild/assets/7237365/84abc13e-b620-468f-a90b-dbf28e7e9427" alt="Rsbuild Logo" /></a>
+# @rsbuild/plugin-toml
+
+An Rsbuild plugin to import TOML files and convert them to JavaScript objects.
+
+> [TOML](https://toml.io/) is a semantically explicit, easy-to-read configuration file format.
+
+<p>
+  <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>
 
-# Rsbuild
+## Usage
+
+Install:
+
+```bash
+npm add @rsbuild/plugin-toml -D
+```
+
+Add plugin to your `rsbuild.config.ts`:
+
+```ts
+// rsbuild.config.ts
+import { pluginToml } from "@rsbuild/plugin-toml";
+
+export default {
+  plugins: [pluginToml()],
+};
+```
+
+## Example
+
+Suppose the project has the following code in `example.toml`:
+
+```toml title="example.toml"
+hello = "world"
+
+[foo]
+bar = "baz"
+```
+
+After using the TOML plugin, you can reference it as follows:
+
+```js
+import example from "./example.toml";
+
+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`.
 
-The Rspack-based build tool. It's fast, out-of-the-box and extensible.
+- Type: `boolean`
+- Default: `true`
+- Example:
 
-## Documentation
+```js
+pluginToml({
+  exModule: false,
+});
+```
 
-https://rsbuild.dev/
+## Type Declaration
 
-## Contributing
+When you import TOML files in TypeScript code, please create a `src/env.d.ts` file in your project and add the type declarations.
 
-Please read the [Contributing Guide](https://github.com/web-infra-dev/rsbuild/blob/main/CONTRIBUTING.md).
+```ts title="src/env.d.ts"
+declare module "*.toml" {
+  const content: Record<string, any>;
+  export default content;
+}
+```
 
 ## License
 
-Rsbuild is [MIT licensed](https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE).
+[MIT](./LICENSE).

package/dist/index.cjs

@@ -35,13 +35,15 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 var PLUGIN_TOML_NAME = "rsbuild:toml";
-var pluginToml = () => ({
+var pluginToml = (options = {}) => ({
   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, void 0, "	")};`;
+      const exportType = esModule ? "export default" : "module.exports =";
+      return `${exportType} ${JSON.stringify(parsed, void 0, "	")};`;
     });
   }
 });

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import { RsbuildPlugin } from '@rsbuild/core';
+
+declare const PLUGIN_TOML_NAME = "rsbuild:toml";
+type PluginTomlOptions = {
+    esModule?: boolean;
+};
+declare const pluginToml: (options?: PluginTomlOptions) => RsbuildPlugin;
+
+export { PLUGIN_TOML_NAME, type PluginTomlOptions, pluginToml };

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import { RsbuildPlugin } from '@rsbuild/core';
 
 declare const PLUGIN_TOML_NAME = "rsbuild:toml";
-declare const pluginToml: () => RsbuildPlugin;
+type PluginTomlOptions = {
+    esModule?: boolean;
+};
+declare const pluginToml: (options?: PluginTomlOptions) => RsbuildPlugin;
 
-export { PLUGIN_TOML_NAME, pluginToml };
+export { PLUGIN_TOML_NAME, type PluginTomlOptions, pluginToml };

package/dist/index.js

@@ -1,20 +1,14 @@
-import { createRequire } from 'module';
-var require = createRequire(import.meta['url']);
-
-
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.52.0_eslint@9.5.0_typescript@5.4.5/node_modules/@modern-js/module-tools/shims/esm.js
-import { fileURLToPath } from "url";
-import path from "path";
-
 // src/index.ts
 var PLUGIN_TOML_NAME = "rsbuild:toml";
-var pluginToml = () => ({
+var pluginToml = (options = {}) => ({
   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, void 0, "	")};`;
+      const exportType = esModule ? "export default" : "module.exports =";
+      return `${exportType} ${JSON.stringify(parsed, void 0, "	")};`;
     });
   }
 });

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "@rsbuild/plugin-toml",
-  "version": "0.7.10",
-  "description": "TOML plugin for Rsbuild",
-  "homepage": "https://rsbuild.dev",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/web-infra-dev/rsbuild",
-    "directory": "packages/plugin-toml"
-  },
+  "version": "1.0.1",
+  "repository": "https://github.com/rspack-contrib/rsbuild-plugin-toml",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -17,28 +11,51 @@
       "require": "./dist/index.cjs"
     }
   },
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "simple-git-hooks": {
+    "pre-commit": "npx nano-staged"
+  },
+  "nano-staged": {
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+      "biome check --write --no-errors-on-unmatched"
+    ]
+  },
   "dependencies": {
     "toml": "^3.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.4.2",
-    "@rsbuild/core": "0.7.10"
+    "@biomejs/biome": "^1.8.3",
+    "@playwright/test": "^1.44.1",
+    "@rsbuild/core": "1.0.1-beta.10",
+    "@types/node": "^20.14.1",
+    "nano-staged": "^0.8.0",
+    "playwright": "^1.44.1",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.0.2",
+    "typescript": "^5.5.2"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^0.7.10"
+    "@rsbuild/core": "0.x || 1.x || ^1.0.1-beta.0"
+  },
+  "peerDependenciesMeta": {
+    "@rsbuild/core": {
+      "optional": true
+    }
   },
   "publishConfig": {
     "access": "public",
-    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "modern build",
-    "dev": "modern build --watch"
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "biome check .",
+    "lint:write": "biome check . --write",
+    "test": "playwright test"
   }
 }