chore: prune tree as default skip api

Author: nyqykk

README.md

@@ -105,10 +105,10 @@ interface projects {
   match?: (stdout: string) => 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 `prune`, the specified project will be pruned, meaning that the project and all its direct and indirect dependencies will not be started by the plugin.
-    * When the value is `true`, the specified project will be skipped from starting, but no pruning will be performed, meaning that the project's direct and indirect dependencies will still be started by the plugin.
-   */
-  skip?: boolean;
+    * 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';
 }
 
 

README.zh-CN.md

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

src/plugin.ts

@@ -12,12 +12,25 @@ export function pluginWorkspaceDev(
     name: 'rsbuild-plugin-workspace-dev',
     async setup(api) {
       const rootPath = api.context.rootPath;
-      api.modifyRsbuildConfig(async () => {
+      api.onBeforeStartDevServer(async () => {
         const runner = new WorkspaceDevRunner({
           cwd: rootPath,
           ...options,
         });
+        await runner.init();
+        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();

src/workspace-dev.ts

@@ -27,7 +27,7 @@ export interface WorkspaceDevRunnerOptions {
     {
       match?: (stdout: string) => boolean;
       command?: string;
-      skip?: boolean | 'prune';
+      skip?: boolean | 'only';
     }
   >;
   startCurrent?: boolean;
@@ -86,14 +86,14 @@ export class WorkspaceDevRunner {
         packageJson,
         path: dir,
       };
-      if (this.options.projects?.[name]?.skip === 'prune') {
+      const skip = this.options.projects?.[name]?.skip;
+      if (skip && skip !== 'only') {
         console.log(
-          `${PLUGIN_LOG_TITLE} Prune project ${name} and its dependencies because it is marked as skip: prune`,
+          `${PLUGIN_LOG_TITLE} Prune project ${name} and its dependencies because it is marked as skip: true`,
         );
         return;
       }
       this.graph.setNode(name, node);
-      // this.visited[name] = this.options.projects?.[name]?.skip ? true : false;
       this.visited[name] = false;
       this.visiting[name] = false;
       this.matched[name] = false;
@@ -110,10 +110,8 @@ export class WorkspaceDevRunner {
           (p) => p.packageJson.name === depName,
         );
 
-        if (
-          isInternalDep &&
-          this.options.projects?.[depName]?.skip !== 'prune'
-        ) {
+        const skip = this.options.projects?.[depName]?.skip;
+        if (isInternalDep && skip !== true) {
           this.graph.setEdge(packageName, depName);
           this.checkGraph();
           const depPackage = packages.find(