chore: rename config && use advanced esm (#7)

Author: nyqykk

README.md

@@ -83,12 +83,17 @@ Whether a sub-project has finished starting is determined by matching sub-projec
 
 ## Options
 
-### projectConfig
+### projects
 Configure how sub-projects are started and define custom log matching logic.
 
 - Type:
 ```
-interface ProjectConfig {
+type projects = {
+  // The key is the name of the sub-project's package.json file.
+  [key: string]: Projects;
+}
+
+interface projects {
   /**
    * Custom sub-project start command. Default is `dev` (runs `npm run dev`).
    */
@@ -104,14 +109,25 @@ interface ProjectConfig {
    */
   skip?: boolean;
 }
+
+
+// For example, to configure lib1 sub-project to use build:watch command and match watch success log
+pluginWorkspaceDev({
+  projects: {
+    lib1: {
+      command: 'build:watch',
+      match: (stdout) => stdout.includes('watch success'),
+    },
+  },
+})
 ```
 
-### ignoreSelf
+### startCurrent
 
 - Type: `boolean`
-- Default: `true`
+- Default: `false`
 
-Whether to ignore starting the current project. The default is `true`. In most cases, you start the current project manually, so the plugin does not interfere.
+Whether to also start the current project. The default is `false`. In most cases, you start the current project manually, so the plugin does not interfere.
 
 Consider a scenario where docs and lib are in the same project, and docs needs to debug the output of lib. In this case, you want to run `pnpm doc` for the docs, while lib should run `pnpm dev`. After configuring this option in your Rspress config, starting `pnpm doc` will automatically run `pnpm dev` to start the lib sub-project.
 
@@ -166,7 +182,7 @@ import { pluginWorkspaceDev } from "rsbuild-plugin-workspace-dev";
 export default {
   plugins: [
     pluginWorkspaceDev({
-      projectConfig: {
+      projects: {
         lib1: {
           skip: true,
         },

README.zh-CN.md

@@ -78,12 +78,17 @@ lib2 依赖了 lib3：
 
 ## 选项
 
-### projectConfig
+### projects
 用于子项目的启动项配置和自定义日志匹配逻辑。
 
-- **类型：**:
+- **类型：**
 ```
-interface ProjectConfig {
+type projects = {
+  // key 为子项目 package.json name
+  [key: string]: Projects;
+}
+
+interface Projects {
   /**
    * 自定义子项目启动命令，默认值为 `dev`, 即执行 `npm run dev`。
    */
@@ -97,14 +102,25 @@ interface ProjectConfig {
    */
   skip?: boolean;
 }
+
+// 例如，配置 lib1 子项目，用 build:watch 命令启动，匹配 watch success 日志
+pluginWorkspaceDev({
+  projects: {
+    lib1: {
+      command: 'build:watch',
+      match: (stdout) => stdout.includes('watch success'),
+    },
+  },
+})
 ```
 
-### ignoreSelf
+
+### startCurrent
 
 - **类型：** `boolean`
-- **默认值：** `true`
-- 
-是否忽略当前项目的启动，默认值为 `true`。一般无需手动配置，当前项目通常由用户手动执行 dev 启动，无需插件干预。
+- **默认值：** `false`
+
+插件是否同时启动当前项目，默认值为 `false`。通常无需手动配置，当前项目通常由用户手动执行 dev 启动，无需插件干预。
 
 考虑如下场景，docs 和 lib 是在同一个项目中，而 docs 需要调试 lib 的产物，此时需要启动 `pnpm doc` 命令，而 lib 则需要启动 `pnpm dev` 命令，配置该选项到 rspress 配置中后，启动 `pnpm doc` 时会自动执行 `pnpm dev` 命令，用于启动 lib 子项目。
 ```
@@ -128,14 +144,14 @@ interface ProjectConfig {
 - **类型：** `string`
 - **默认值：** `process.cwd()`
 
-用于配置当前工作目录，默认值为当前项目目录，一般无需配置。
+用于配置当前工作目录，默认值为当前项目目录，通常无需配置。
 
 ### workspaceFileDir
 
 - **类型：** `string`
 - **默认值：** `process.cwd()`
 
-用于配置 workspace 文件目录，默认值为当前项目目录，一般无需配置。
+用于配置 workspace 文件目录，默认值为当前项目目录，通常无需配置。
 
 
 ## 常见问题
@@ -156,7 +172,7 @@ import { pluginWorkspaceDev } from "rsbuild-plugin-workspace-dev";
 export default {
   plugins: [
     pluginWorkspaceDev({
-      projectConfig: {
+      projects: {
         lib1: {
           skip: true,
         },

rslib.config.ts

@@ -2,7 +2,12 @@ import { defineConfig } from '@rslib/core';
 
 export default defineConfig({
   lib: [
-    { format: 'esm', syntax: 'es2021', dts: true },
+    {
+      format: 'esm',
+      syntax: 'es2021',
+      dts: true,
+      experiments: { advancedEsm: true },
+    },
     { format: 'cjs', syntax: 'es2021' },
   ],
 });

src/workspace-dev.ts

@@ -22,15 +22,15 @@ interface GraphNode {
 export interface WorkspaceDevRunnerOptions {
   cwd?: string;
   workspaceFileDir?: string;
-  projectConfig?: Record<
+  projects?: Record<
     string,
     {
       match?: (stdout: string) => boolean;
       command?: string;
       skip?: boolean;
     }
   >;
-  ignoreSelf?: boolean;
+  startCurrent?: boolean;
 }
 
 export class WorkspaceDevRunner {
@@ -46,7 +46,7 @@ export class WorkspaceDevRunner {
 
   constructor(options: WorkspaceDevRunnerOptions) {
     this.options = {
-      ignoreSelf: true,
+      startCurrent: false,
       ...options,
     };
     this.cwd = options.cwd || process.cwd();
@@ -136,7 +136,7 @@ export class WorkspaceDevRunner {
     const filterSelfNodes = allNodes.filter(
       (node) => node !== this.metaData.name,
     );
-    const nodes = this.options.ignoreSelf ? filterSelfNodes : allNodes;
+    const nodes = this.options.startCurrent ? allNodes : filterSelfNodes;
 
     for (const node of nodes) {
       const dependencies = this.getDependencies(node) || [];
@@ -162,7 +162,7 @@ export class WorkspaceDevRunner {
       const logger = new Logger({
         name,
       });
-      const config = this.options?.projectConfig?.[name];
+      const config = this.options?.projects?.[name];
       if (config?.skip) {
         this.visited[node] = true;
         this.visiting[node] = false;

test/doc/rspress.config.ts

@@ -30,7 +30,7 @@ export default defineConfig({
   builderConfig: {
     plugins: [
       pluginWorkspaceDev({
-        ignoreSelf: false,
+        startCurrent: true,
       }),
     ],
   },

test/index.test.ts

@@ -127,7 +127,7 @@ it('test', async () => {
     return matched;
   };
   const runner = new WorkspaceDevRunner({
-    projectConfig: {
+    projects: {
       a: {
         match: (stdout) => matchFn(stdout, 'a'),
       },