rsbuild-plugin-devtools-json 0.2.0 → 0.2.2

package/dist/index.d.ts

@@ -1,5 +1,15 @@
-import type { RsbuildPlugin } from '@rsbuild/core';
-declare const plugin: (options?: {
-    uuid: string;
-}) => RsbuildPlugin;
-export default plugin;
+import { type RsbuildPlugin } from '@rsbuild/core';
+export type PluginDevtoolsJsonOptions = {
+    /**
+     * The UUID to use for the DevTools project settings.
+     * If not provided, a new UUID will be generated.
+     */
+    uuid?: string;
+    /**
+     * The root path for the DevTools project settings.
+     * In monorepo, you can set this to the monorepo root directory, especially when used with [rsbuild-plugin-source-build](https://github.com/rspack-contrib/rsbuild-plugin-source-build).
+     * If not provided, the default root path from Rsbuild context will be used.
+     */
+    rootPath?: string;
+};
+export declare const pluginDevtoolsJson: (options?: PluginDevtoolsJsonOptions) => RsbuildPlugin;

package/dist/index.js

@@ -1,11 +1,11 @@
 import node_fs from "node:fs";
 import node_path from "node:path";
+import { logger } from "@rsbuild/core";
 import { v4, validate } from "uuid";
 const ENDPOINT = '/.well-known/appspecific/com.chrome.devtools.json';
-const src_plugin = (options)=>({
+const pluginDevtoolsJson = (options)=>({
         name: 'rsbuild-plugin-devtools-json',
         setup (api) {
-            if ('development' !== process.env.NODE_ENV) return;
             const getOrCreateUUID = ()=>{
                 if (options?.uuid) return options.uuid;
                 const cacheDir = api.context.cachePath;
@@ -23,33 +23,25 @@ const src_plugin = (options)=>({
                 node_fs.writeFileSync(uuidPath, uuid, {
                     encoding: 'utf-8'
                 });
-                console.log(`[rsbuild-plugin-devtools-json] Generated UUID '${uuid}' for DevTools project settings.`);
+                logger.info(`[rsbuild-plugin-devtools-json] Generated UUID '${uuid}' for DevTools project settings.`);
                 return uuid;
             };
-            api.modifyRsbuildConfig((userConfig, { mergeRsbuildConfig })=>mergeRsbuildConfig(userConfig, {
-                    dev: {
-                        setupMiddlewares: [
-                            (middlewares)=>{
-                                middlewares.push((req, res, next)=>{
-                                    if (req.url !== ENDPOINT) return next();
-                                    let root = api.context.rootPath;
-                                    if (process.env.WSL_DISTRO_NAME) root = node_path.join('\\\\wsl.localhost', process.env.WSL_DISTRO_NAME, root).replace(/\//g, '\\');
-                                    const uuid = getOrCreateUUID();
-                                    const devtoolsJson = {
-                                        workspace: {
-                                            root,
-                                            uuid
-                                        }
-                                    };
-                                    res.setHeader('Content-Type', 'application/json');
-                                    res.end(JSON.stringify(devtoolsJson, null, 2));
-                                });
-                                return middlewares;
-                            }
-                        ]
-                    }
-                }));
+            api.onBeforeStartDevServer(({ server })=>{
+                server.middlewares.use((req, res, next)=>{
+                    if (req.url !== ENDPOINT) return next();
+                    let root = options?.rootPath || api.context.rootPath;
+                    if (!options?.rootPath && process.env.WSL_DISTRO_NAME) root = node_path.join('\\\\wsl.localhost', process.env.WSL_DISTRO_NAME, root).replace(/\//g, '\\');
+                    const uuid = getOrCreateUUID();
+                    const devtoolsJson = {
+                        workspace: {
+                            root,
+                            uuid
+                        }
+                    };
+                    res.setHeader('Content-Type', 'application/json');
+                    res.end(JSON.stringify(devtoolsJson, null, 2));
+                });
+            });
         }
     });
-const src = src_plugin;
-export { src as default };
+export { pluginDevtoolsJson };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsbuild-plugin-devtools-json",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -13,6 +13,23 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "rslib build",
+    "lint": "biome check",
+    "lint:write": "biome check . --write",
+    "dev": "rslib build --watch",
+    "prepare": "simple-git-hooks && npm run build",
+    "format": "biome format --write",
+    "bump": "npx bumpp"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx nano-staged"
+  },
+  "nano-staged": {
+    "*.{js,jsx,ts,tsx,mjs,cjs}": [
+      "biome check --write --no-errors-on-unmatched"
+    ]
+  },
   "dependencies": {
     "uuid": "^11.1.0"
   },
@@ -20,17 +37,17 @@
     "@biomejs/biome": "2.0.4",
     "@rslib/core": "0.10.2",
     "@types/node": "24.0.3",
+    "nano-staged": "^0.8.0",
+    "simple-git-hooks": "^2.13.0",
     "typescript": "5.8.3"
   },
   "peerDependencies": {
     "@rsbuild/core": "^1"
   },
-  "scripts": {
-    "build": "rslib build",
-    "lint": "biome check",
-    "lint:write": "biome check . --write",
-    "dev": "rslib build --watch",
-    "format": "biome format --write",
-    "bump": "npx bumpp"
-  }
-}
+  "peerDependenciesMeta": {
+    "@rsbuild/core": {
+      "optional": true
+    }
+  },
+  "packageManager": "pnpm@9.15.2"
+}