rsbuild-plugin-virtual-module 0.0.1 → 0.1.1

package/README.md

@@ -22,29 +22,73 @@ Add plugin to your `rsbuild.config.ts`:
 
 ```ts
 // rsbuild.config.ts
-import { pluginVirtualModule } from "rsbuild-plugin-virtual-module";
+import { pluginVirtualModule } from 'rsbuild-plugin-virtual-module';
 
 export default {
-  plugins: [pluginVirtualModule()],
+  plugins: [
+    pluginVirtualModule({
+      virtualModules: {
+        'virtual-foo': async () => {
+          return 'export default {}';
+        },
+      },
+    }),
+  ],
 };
 ```
 
+```ts
+import foo from 'virtual-foo';
+
+console.log(foo); // {}
+```
+
 ## Options
 
-### foo
+### virtualModules
+
+Generate virtual modules, where the key is the name of the virtual module and the value is `TransformHandler`. See [Rsbuild - api.transform](https://rsbuild.dev/plugins/dev/core#apitransform)
+
+- Type:
+
+```ts
+import type { RsbuildPlugin, TransformHandler } from '@rsbuild/core';
 
-Some description.
+type VirtualModules = Record<string, TransformHandler>;
+```
 
-- Type: `string`
-- Default: `undefined`
+- Default: `{}`
 - Example:
 
 ```js
 pluginVirtualModule({
-  foo: "bar",
+  virtualModules: {
+    'virtual-json-list': async ({ addDependency, addContextDependency }) => {
+      const jsonFolderPath = join(__dirname, 'json');
+      const ls = await readdir(jsonFolderPath);
+      addContextDependency(jsonFolderPath);
+
+      const res: Record<string, unknown> = {};
+      for (const file of ls) {
+        if (file.endsWith('.json')) {
+          const jsonFilePath = join(jsonFolderPath, file);
+          const jsonContent = await readFile(jsonFilePath, 'utf-8');
+          addDependency(jsonFilePath);
+          res[file] = JSON.parse(jsonContent);
+        }
+      }
+
+      return `export default ${JSON.stringify(res)}`;
+    },
+  },
 });
 ```
 
+```js
+import jsonList from 'virtual-json-list';
+console.log(jsonList);
+```
+
 ## License
 
 [MIT](./LICENSE).

package/dist/index.cjs

@@ -1,7 +1,7 @@
 "use strict";
 var __webpack_require__ = {};
 (()=>{
-    __webpack_require__.d = function(exports1, definition) {
+    __webpack_require__.d = (exports1, definition)=>{
         for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
             enumerable: true,
             get: definition[key]
@@ -9,12 +9,10 @@ var __webpack_require__ = {};
     };
 })();
 (()=>{
-    __webpack_require__.o = function(obj, prop) {
-        return Object.prototype.hasOwnProperty.call(obj, prop);
-    };
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
 })();
 (()=>{
-    __webpack_require__.r = function(exports1) {
+    __webpack_require__.r = (exports1)=>{
         if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
             value: 'Module'
         });
@@ -26,16 +24,48 @@ var __webpack_require__ = {};
 var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
+    PLUGIN_VIRTUAL_MODULE_NAME: ()=>PLUGIN_VIRTUAL_MODULE_NAME,
     pluginVirtualModule: ()=>pluginVirtualModule
 });
-const pluginVirtualModule = (options = {})=>({
-        name: 'plugin-example',
-        setup () {
-            console.log('Hello Rsbuild!', options);
+const promises_namespaceObject = require("node:fs/promises");
+const external_node_path_namespaceObject = require("node:path");
+const PLUGIN_VIRTUAL_MODULE_NAME = 'rsbuild:virtual-module';
+const pluginVirtualModule = (pluginOptions = {})=>({
+        name: PLUGIN_VIRTUAL_MODULE_NAME,
+        async setup (api) {
+            const TEMP_DIR = (0, external_node_path_namespaceObject.join)(process.cwd(), 'node_modules/.rsbuild-virtual-module');
+            const { virtualModules = {} } = pluginOptions;
+            const virtualFileAbsolutePaths = Object.keys(virtualModules).map((i)=>{
+                let absolutePath = (0, external_node_path_namespaceObject.join)(TEMP_DIR, i);
+                if (!(0, external_node_path_namespaceObject.extname)(absolutePath)) absolutePath = `${absolutePath}.js`;
+                return [
+                    i,
+                    absolutePath
+                ];
+            });
+            api.onBeforeCreateCompiler(async ()=>{
+                await (0, promises_namespaceObject.mkdir)(TEMP_DIR, {
+                    recursive: true
+                });
+                await Promise.all(virtualFileAbsolutePaths.map(([_, absolutePath])=>(0, promises_namespaceObject.writeFile)(absolutePath, '', 'utf-8')));
+            });
+            api.modifyBundlerChain((chain)=>{
+                chain.resolve.alias.merge(Object.fromEntries(virtualFileAbsolutePaths));
+            });
+            for (const [moduleName, absolutePath] of virtualFileAbsolutePaths){
+                const handler = virtualModules[moduleName];
+                if (handler) api.transform({
+                    test: absolutePath
+                }, handler);
+            }
         }
     });
-var __webpack_export_target__ = exports;
-for(var __webpack_i__ in __webpack_exports__)__webpack_export_target__[__webpack_i__] = __webpack_exports__[__webpack_i__];
-if (__webpack_exports__.__esModule) Object.defineProperty(__webpack_export_target__, '__esModule', {
+exports.PLUGIN_VIRTUAL_MODULE_NAME = __webpack_exports__.PLUGIN_VIRTUAL_MODULE_NAME;
+exports.pluginVirtualModule = __webpack_exports__.pluginVirtualModule;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "PLUGIN_VIRTUAL_MODULE_NAME",
+    "pluginVirtualModule"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
     value: true
 });

package/dist/index.d.ts

@@ -1,6 +1,9 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-export type pluginVirtualModuleOptions = {
-    foo?: string;
-    bar?: boolean;
-};
-export declare const pluginVirtualModule: (options?: pluginVirtualModuleOptions) => RsbuildPlugin;
+import type { RsbuildPlugin, TransformHandler } from '@rsbuild/core';
+type VirtualModules = Record<string, TransformHandler>;
+interface PluginVirtualModuleOptions {
+    virtualModules?: VirtualModules;
+}
+declare const PLUGIN_VIRTUAL_MODULE_NAME = "rsbuild:virtual-module";
+declare const pluginVirtualModule: (pluginOptions?: PluginVirtualModuleOptions) => RsbuildPlugin;
+export { pluginVirtualModule, PLUGIN_VIRTUAL_MODULE_NAME };
+export type { PluginVirtualModuleOptions, VirtualModules };

package/dist/index.js

@@ -1,7 +1,34 @@
-const pluginVirtualModule = (options = {})=>({
-        name: 'plugin-example',
-        setup () {
-            console.log('Hello Rsbuild!', options);
+import * as __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__ from "node:fs/promises";
+import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
+const PLUGIN_VIRTUAL_MODULE_NAME = 'rsbuild:virtual-module';
+const pluginVirtualModule = (pluginOptions = {})=>({
+        name: PLUGIN_VIRTUAL_MODULE_NAME,
+        async setup (api) {
+            const TEMP_DIR = (0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.join)(process.cwd(), 'node_modules/.rsbuild-virtual-module');
+            const { virtualModules = {} } = pluginOptions;
+            const virtualFileAbsolutePaths = Object.keys(virtualModules).map((i)=>{
+                let absolutePath = (0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.join)(TEMP_DIR, i);
+                if (!(0, __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.extname)(absolutePath)) absolutePath = `${absolutePath}.js`;
+                return [
+                    i,
+                    absolutePath
+                ];
+            });
+            api.onBeforeCreateCompiler(async ()=>{
+                await (0, __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__.mkdir)(TEMP_DIR, {
+                    recursive: true
+                });
+                await Promise.all(virtualFileAbsolutePaths.map(([_, absolutePath])=>(0, __WEBPACK_EXTERNAL_MODULE_node_fs_promises_153e37e0__.writeFile)(absolutePath, '', 'utf-8')));
+            });
+            api.modifyBundlerChain((chain)=>{
+                chain.resolve.alias.merge(Object.fromEntries(virtualFileAbsolutePaths));
+            });
+            for (const [moduleName, absolutePath] of virtualFileAbsolutePaths){
+                const handler = virtualModules[moduleName];
+                if (handler) api.transform({
+                    test: absolutePath
+                }, handler);
+            }
         }
     });
-export { pluginVirtualModule };
+export { PLUGIN_VIRTUAL_MODULE_NAME, pluginVirtualModule };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "rsbuild-plugin-virtual-module",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/rspack-contrib/rsbuild-plugin-template.git"
+    "url": "https://github.com/rspack-contrib/rsbuild-plugin-virtual-module"
   },
   "license": "MIT",
   "type": "module",
@@ -25,13 +25,14 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@playwright/test": "^1.50.1",
-    "@rsbuild/core": "^1.2.13",
-    "@rslib/core": "^0.5.2",
-    "@types/node": "^22.13.7",
-    "playwright": "^1.50.1",
-    "simple-git-hooks": "^2.11.1",
-    "typescript": "^5.8.2"
+    "@playwright/test": "^1.51.1",
+    "@rsbuild/core": "^1.3.1",
+    "@rslib/core": "^0.6.1",
+    "@types/node": "^22.13.16",
+    "playwright": "^1.51.1",
+    "simple-git-hooks": "^2.12.1",
+    "typescript": "^5.8.2",
+    "rsbuild-plugin-virtual-module": "0.1.1"
   },
   "peerDependencies": {
     "@rsbuild/core": "1.x"