rsbuild-plugin-workspace-dev 0.0.2 → 0.1.1

package/README.md

@@ -104,10 +104,11 @@ interface projects {
    */
   match?: (stdout: string) => boolean;
   /**
-   * Whether to skip starting the current sub-project. Default is `false`.
-   * Useful for sub-projects that do not need to be started.
-   */
-  skip?: boolean;
+    * Whether to skip starting the current sub-project. The default value is `false`, typically used to skip sub-projects that don't need to be started.
+    * When the value is `true`, pruning will be performed on the specified project, meaning that this project and all its direct and indirect dependencies will not be started by the plugin.
+    * When the value is `only`, starting the specified project will be skipped, but no pruning will be performed, meaning that the project's direct and indirect dependencies will still be started by the plugin.
+  */
+  skip?: boolean | 'only';
 }
 
 

package/README.zh-CN.md

@@ -99,8 +99,10 @@ interface Projects {
   match?: (stdout: string) => boolean;
   /**
    * 是否跳过当前子项目的启动，默认值为 `false`，通常用于跳过一些不需要启动的子项目。
+   * 当值为 `true` 时，会从指定项目进行剪枝，这意味着该项目以及他的所有直接和间接依赖都不会被插件启动。
+   * 当值为 `only` 时，会跳过指定项目的启动，但不会进行剪枝，这意味着该项目的直接和间接依赖仍然会被插件启动。
    */
-  skip?: boolean;
+  skip?: boolean | 'only';
 }
 
 // 例如，配置 lib1 子项目，用 build:watch 命令启动，匹配 watch success 日志

package/dist/constant.d.ts

@@ -1,5 +1,4 @@
 export declare const PACKAGE_JSON = "package.json";
-export declare const DEBUG_LOG_TITLE = "[Rsbuild Workspace Dev Plugin]: ";
+export declare const PLUGIN_LOG_TITLE = "[Rsbuild Workspace Dev Plugin]: ";
 export declare const RSLIB_READY_MESSAGE = "build complete, watching for changes";
-export declare const MODERN_MODULE_READY_MESSAGE = "Watching for file changes";
 export declare const TSUP_READY_MESSAGE = "Watching for changes in";

package/dist/index.cjs

@@ -39,9 +39,8 @@ __webpack_require__.d(__webpack_exports__, {
 const external_chalk_namespaceObject = require("chalk");
 var external_chalk_default = /*#__PURE__*/ __webpack_require__.n(external_chalk_namespaceObject);
 const PACKAGE_JSON = 'package.json';
-const DEBUG_LOG_TITLE = '[Rsbuild Workspace Dev Plugin]: ';
+const PLUGIN_LOG_TITLE = '[Rsbuild Workspace Dev Plugin]: ';
 const RSLIB_READY_MESSAGE = 'build complete, watching for changes';
-const MODERN_MODULE_READY_MESSAGE = 'Watching for file changes';
 const TSUP_READY_MESSAGE = 'Watching for changes in';
 const external_fs_namespaceObject = require("fs");
 var external_fs_default = /*#__PURE__*/ __webpack_require__.n(external_fs_namespaceObject);
@@ -107,10 +106,10 @@ class Logger {
         this.name = name;
         this.stdout = '';
         this.stderr = '';
-        this.logTitle = DEBUG_LOG_TITLE;
+        this.logTitle = PLUGIN_LOG_TITLE;
     }
 }
-const debugLog = (msg, prefix = DEBUG_LOG_TITLE)=>{
+const debugLog = (msg, prefix = PLUGIN_LOG_TITLE)=>{
     if (isDebug) console.log(prefix + msg);
 };
 const get_packages_namespaceObject = require("@manypkg/get-packages");
@@ -118,7 +117,6 @@ const external_child_process_namespaceObject = require("child_process");
 const external_graphlib_namespaceObject = require("graphlib");
 var external_graphlib_default = /*#__PURE__*/ __webpack_require__.n(external_graphlib_namespaceObject);
 const external_path_namespaceObject = require("path");
-var external_path_default = /*#__PURE__*/ __webpack_require__.n(external_path_namespaceObject);
 function workspace_dev_define_property(obj, key, value) {
     if (key in obj) Object.defineProperty(obj, key, {
         value: value,
@@ -131,7 +129,7 @@ function workspace_dev_define_property(obj, key, value) {
 }
 class WorkspaceDevRunner {
     async init() {
-        this.metaData = await readPackageJson(external_path_default().join(this.cwd, PACKAGE_JSON));
+        this.metaData = await readPackageJson((0, external_path_namespaceObject.join)(this.cwd, PACKAGE_JSON));
         this.buildDependencyGraph();
         debugLog(`Dependency graph:\nnodes: ${this.getNodes().join(', ')}\nedges: ${this.getEdges().map((edge)=>`${edge.v} -> ${edge.w}`).join(', ')}\n`);
     }
@@ -147,6 +145,8 @@ class WorkspaceDevRunner {
                 packageJson,
                 path: dir
             };
+            const skip = this.options.projects?.[name]?.skip;
+            if (true === skip) return;
             this.graph.setNode(name, node);
             this.visited[name] = false;
             this.visiting[name] = false;
@@ -159,12 +159,13 @@ class WorkspaceDevRunner {
             };
             for (const depName of Object.keys(deps)){
                 const isInternalDep = this.packages.some((p)=>p.packageJson.name === depName);
-                if (isInternalDep) {
+                const skip = this.options.projects?.[depName]?.skip;
+                if (isInternalDep) if (true !== skip) {
                     this.graph.setEdge(packageName, depName);
                     this.checkGraph();
                     const depPackage = packages.find((pkg)=>pkg.packageJson.name === depName);
                     if (!this.getNode(depName)) initNode(depPackage);
-                }
+                } else debugLog(`Prune project ${depName} and its dependencies because it is marked as skip: true`);
             }
         };
         initNode(currentPackage);
@@ -172,8 +173,11 @@ class WorkspaceDevRunner {
     checkGraph() {
         const cycles = external_graphlib_default().alg.findCycles(this.graph);
         const nonSelfCycles = cycles.filter((c)=>1 !== c.length);
-        debugLog(`cycles check: ${cycles}`);
-        if (nonSelfCycles.length) throw new Error(`${DEBUG_LOG_TITLE}Dependency graph do not allow cycles.`);
+        const nonSkipCycles = nonSelfCycles.filter((group)=>{
+            const isSkip = group.some((node)=>this.options.projects?.[node]?.skip);
+            return !isSkip;
+        });
+        if (nonSkipCycles.length) throw new Error(`${PLUGIN_LOG_TITLE} Cycle dependency graph found: ${nonSkipCycles}, you should config projects in plugin options to skip someone, or fix the cycle dependency. Otherwise, a loop of dev will occur.`);
     }
     async start() {
         const promises = [];
@@ -185,7 +189,8 @@ class WorkspaceDevRunner {
             const canStart = dependencies.every((dep)=>{
                 const selfStart = node === dep;
                 const isVisiting = this.visiting[dep];
-                const isVisited = selfStart || this.visited[dep];
+                const skipDep = this.options.projects?.[dep]?.skip;
+                const isVisited = selfStart || this.visited[dep] || skipDep;
                 return isVisited && !isVisiting;
             });
             if (canStart && !this.visited[node] && !this.visiting[node]) {
@@ -198,22 +203,24 @@ class WorkspaceDevRunner {
     }
     visitNodes(node) {
         return new Promise((resolve)=>{
-            const { name, path } = this.getNode(node);
+            const { name, path, packageJson } = this.getNode(node);
             const logger = new Logger({
                 name
             });
             const config = this.options?.projects?.[name];
-            if (config?.skip) {
+            const command = config?.command ? config.command : 'dev';
+            const scripts = packageJson.scripts || {};
+            if (config?.skip || !scripts[command]) {
                 this.visited[node] = true;
                 this.visiting[node] = false;
                 debugLog(`Skip visit node: ${node}`);
-                logger.emitLogOnce('stdout', `skip visit node: ${name}`);
+                logger.emitLogOnce('stdout', `Skip visit node: ${name}`);
                 return this.start().then(()=>resolve());
             }
             this.visiting[node] = true;
             const child = (0, external_child_process_namespaceObject.spawn)('npm', [
                 'run',
-                config?.command ? config.command : 'dev'
+                command
             ], {
                 cwd: path,
                 env: {
@@ -229,7 +236,7 @@ class WorkspaceDevRunner {
                 debugLog(content, `${name}: `);
                 logger.appendLog('stdout', stdout);
                 const match = config?.match;
-                const matchResult = match ? match(stdout) : stdout.match(RSLIB_READY_MESSAGE) || stdout.match(MODERN_MODULE_READY_MESSAGE) || stdout.match(TSUP_READY_MESSAGE);
+                const matchResult = match ? match(stdout) : stdout.match(RSLIB_READY_MESSAGE) || stdout.match(TSUP_READY_MESSAGE);
                 if (matchResult) {
                     logger.flushStdout();
                     this.matched[node] = true;
@@ -303,6 +310,16 @@ function pluginWorkspaceDev(options) {
                 await runner.start();
                 Logger.setEndBanner();
             });
+            api.onBeforeBuild(async ({ isWatch, isFirstCompile })=>{
+                if (!isWatch || !isFirstCompile) return;
+                const runner = new WorkspaceDevRunner({
+                    cwd: rootPath,
+                    ...options
+                });
+                await runner.init();
+                await runner.start();
+                Logger.setEndBanner();
+            });
         }
     };
 }

package/dist/index.js

@@ -4,11 +4,10 @@ import json5 from "json5";
 import { getPackagesSync } from "@manypkg/get-packages";
 import { spawn } from "child_process";
 import graphlib, { Graph } from "graphlib";
-import path_0 from "path";
+import { join } from "path";
 const PACKAGE_JSON = 'package.json';
-const DEBUG_LOG_TITLE = '[Rsbuild Workspace Dev Plugin]: ';
+const PLUGIN_LOG_TITLE = '[Rsbuild Workspace Dev Plugin]: ';
 const RSLIB_READY_MESSAGE = 'build complete, watching for changes';
-const MODERN_MODULE_READY_MESSAGE = 'Watching for file changes';
 const TSUP_READY_MESSAGE = 'Watching for changes in';
 async function pathExists(path) {
     return fs.promises.access(path).then(()=>true).catch(()=>false);
@@ -70,10 +69,10 @@ class Logger {
         this.name = name;
         this.stdout = '';
         this.stderr = '';
-        this.logTitle = DEBUG_LOG_TITLE;
+        this.logTitle = PLUGIN_LOG_TITLE;
     }
 }
-const debugLog = (msg, prefix = DEBUG_LOG_TITLE)=>{
+const debugLog = (msg, prefix = PLUGIN_LOG_TITLE)=>{
     if (isDebug) console.log(prefix + msg);
 };
 function workspace_dev_define_property(obj, key, value) {
@@ -88,7 +87,7 @@ function workspace_dev_define_property(obj, key, value) {
 }
 class WorkspaceDevRunner {
     async init() {
-        this.metaData = await readPackageJson(path_0.join(this.cwd, PACKAGE_JSON));
+        this.metaData = await readPackageJson(join(this.cwd, PACKAGE_JSON));
         this.buildDependencyGraph();
         debugLog(`Dependency graph:\nnodes: ${this.getNodes().join(', ')}\nedges: ${this.getEdges().map((edge)=>`${edge.v} -> ${edge.w}`).join(', ')}\n`);
     }
@@ -104,6 +103,8 @@ class WorkspaceDevRunner {
                 packageJson,
                 path: dir
             };
+            const skip = this.options.projects?.[name]?.skip;
+            if (true === skip) return;
             this.graph.setNode(name, node);
             this.visited[name] = false;
             this.visiting[name] = false;
@@ -116,12 +117,13 @@ class WorkspaceDevRunner {
             };
             for (const depName of Object.keys(deps)){
                 const isInternalDep = this.packages.some((p)=>p.packageJson.name === depName);
-                if (isInternalDep) {
+                const skip = this.options.projects?.[depName]?.skip;
+                if (isInternalDep) if (true !== skip) {
                     this.graph.setEdge(packageName, depName);
                     this.checkGraph();
                     const depPackage = packages.find((pkg)=>pkg.packageJson.name === depName);
                     if (!this.getNode(depName)) initNode(depPackage);
-                }
+                } else debugLog(`Prune project ${depName} and its dependencies because it is marked as skip: true`);
             }
         };
         initNode(currentPackage);
@@ -129,8 +131,11 @@ class WorkspaceDevRunner {
     checkGraph() {
         const cycles = graphlib.alg.findCycles(this.graph);
         const nonSelfCycles = cycles.filter((c)=>1 !== c.length);
-        debugLog(`cycles check: ${cycles}`);
-        if (nonSelfCycles.length) throw new Error(`${DEBUG_LOG_TITLE}Dependency graph do not allow cycles.`);
+        const nonSkipCycles = nonSelfCycles.filter((group)=>{
+            const isSkip = group.some((node)=>this.options.projects?.[node]?.skip);
+            return !isSkip;
+        });
+        if (nonSkipCycles.length) throw new Error(`${PLUGIN_LOG_TITLE} Cycle dependency graph found: ${nonSkipCycles}, you should config projects in plugin options to skip someone, or fix the cycle dependency. Otherwise, a loop of dev will occur.`);
     }
     async start() {
         const promises = [];
@@ -142,7 +147,8 @@ class WorkspaceDevRunner {
             const canStart = dependencies.every((dep)=>{
                 const selfStart = node === dep;
                 const isVisiting = this.visiting[dep];
-                const isVisited = selfStart || this.visited[dep];
+                const skipDep = this.options.projects?.[dep]?.skip;
+                const isVisited = selfStart || this.visited[dep] || skipDep;
                 return isVisited && !isVisiting;
             });
             if (canStart && !this.visited[node] && !this.visiting[node]) {
@@ -155,22 +161,24 @@ class WorkspaceDevRunner {
     }
     visitNodes(node) {
         return new Promise((resolve)=>{
-            const { name, path } = this.getNode(node);
+            const { name, path, packageJson } = this.getNode(node);
             const logger = new Logger({
                 name
             });
             const config = this.options?.projects?.[name];
-            if (config?.skip) {
+            const command = config?.command ? config.command : 'dev';
+            const scripts = packageJson.scripts || {};
+            if (config?.skip || !scripts[command]) {
                 this.visited[node] = true;
                 this.visiting[node] = false;
                 debugLog(`Skip visit node: ${node}`);
-                logger.emitLogOnce('stdout', `skip visit node: ${name}`);
+                logger.emitLogOnce('stdout', `Skip visit node: ${name}`);
                 return this.start().then(()=>resolve());
             }
             this.visiting[node] = true;
             const child = spawn('npm', [
                 'run',
-                config?.command ? config.command : 'dev'
+                command
             ], {
                 cwd: path,
                 env: {
@@ -186,7 +194,7 @@ class WorkspaceDevRunner {
                 debugLog(content, `${name}: `);
                 logger.appendLog('stdout', stdout);
                 const match = config?.match;
-                const matchResult = match ? match(stdout) : stdout.match(RSLIB_READY_MESSAGE) || stdout.match(MODERN_MODULE_READY_MESSAGE) || stdout.match(TSUP_READY_MESSAGE);
+                const matchResult = match ? match(stdout) : stdout.match(RSLIB_READY_MESSAGE) || stdout.match(TSUP_READY_MESSAGE);
                 if (matchResult) {
                     logger.flushStdout();
                     this.matched[node] = true;
@@ -260,6 +268,16 @@ function pluginWorkspaceDev(options) {
                 await runner.start();
                 Logger.setEndBanner();
             });
+            api.onBeforeBuild(async ({ isWatch, isFirstCompile })=>{
+                if (!isWatch || !isFirstCompile) return;
+                const runner = new WorkspaceDevRunner({
+                    cwd: rootPath,
+                    ...options
+                });
+                await runner.init();
+                await runner.start();
+                Logger.setEndBanner();
+            });
         }
     };
 }

package/dist/types.d.ts

@@ -0,0 +1,6 @@
+import type { Package } from '@manypkg/get-packages';
+export interface PackageWithScripts extends Package {
+    packageJson: Package['packageJson'] & {
+        scripts?: Record<string, string>;
+    };
+}

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import type { Package } from '@manypkg/get-packages';
+import type { PackageWithScripts } from './types.js';
 export declare const readJson: <T>(jsonFileAbsPath: string) => Promise<T>;
-export declare const readPackageJson: (pkgJsonFilePath: string) => Promise<Package["packageJson"]>;
+export declare const readPackageJson: (pkgJsonFilePath: string) => Promise<PackageWithScripts["packageJson"]>;
 export declare const isDebug: boolean;

package/dist/workspace-dev.d.ts

@@ -5,7 +5,7 @@ export interface WorkspaceDevRunnerOptions {
     projects?: Record<string, {
         match?: (stdout: string) => boolean;
         command?: string;
-        skip?: boolean;
+        skip?: boolean | 'only';
     }>;
     startCurrent?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rsbuild-plugin-workspace-dev",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "An Rsbuild plugin to provides workspace recursive dev functionality for Monorepo topologies.",
   "repository": "https://github.com/rspack-contrib/rsbuild-plugin-workspace-dev",
   "license": "MIT",