@rsbuild/plugin-source-build 1.0.1 → 1.0.3

package/README.md

@@ -136,13 +136,10 @@ Project reference provides the following capabilities:
 
 ### Example
 
-In the example mentioned earlier, since the app project references the lib sub-project, we need to configure the `composite` and `references` options in the app project's `tsconfig.json` file and point them to the corresponding relative directory of lib:
+In the example mentioned earlier, since the app project references the lib sub-project, we need to configure the `references` options in the app project's `tsconfig.json` to point to the relative directory of the lib:
 
 ```json title="app/tsconfig.json"
 {
-  "compilerOptions": {
-    "composite": true
-  },
   "references": [
     {
       "path": "../lib"
@@ -151,6 +148,16 @@ In the example mentioned earlier, since the app project references the lib sub-p
 }
 ```
 
+At the same time, we need to set `composite` to `true` in the lib project's `tsconfig.json`:
+
+```json title="lib/A/tsconfig.json"
+{
+  "compilerOptions": {
+    "composite": true
+  },
+}
+```
+
 After adding these two options, the project reference is already configured. You can restart VS Code to see the effects of the configuration.
 
 Note that the above example is a simplified one. In real monorepo projects, there may be more complex dependency relationships. You need to add a complete `references` configuration for the functionality to work correctly.

package/README.zh-CN.md

@@ -134,13 +134,10 @@ Project reference 提供了以下能力：
 
 ### 示例
 
-在上文的例子中，由于 app 引用了 lib 子项目，我们需要在 app 的 `tsconfig.json` 内配置 `composite` 和 `references`，并指向 lib 对应的相对目录：
+在上文的例子中，由于 app 引用了 lib 子项目，我们需要在 app 的 `tsconfig.json` 内配置 `references`，并指向 lib 对应的相对目录：
 
 ```json title="app/tsconfig.json"
 {
-  "compilerOptions": {
-    "composite": true
-  },
   "references": [
     {
       "path": "../lib"
@@ -149,6 +146,16 @@ Project reference 提供了以下能力：
 }
 ```
 
+同时，需要在 lib 子项目的 `tsconfig.json` 内配置 `composite` 为 `true`：
+
+```json title="lib/A/tsconfig.json"
+{
+  "compilerOptions": {
+    "composite": true
+  },
+}
+```
+
 添加以上两个选项后，project reference 就已经配置完成了，你可以重新启动 VS Code 来查看配置以后的效果。
 
 注意以上只是一个最简单的例子，在实际的 monorepo 项目中，可能会有更复杂的依赖关系，你需要添加完整的 `references` 配置，才能使上述功能正确运作。

package/dist/common/getBaseData.d.ts

@@ -0,0 +1,9 @@
+import type { MonorepoAnalyzer } from '../types/index.js';
+import type { GetProjectsFunc } from './getProjects.js';
+export interface IMonorepoBaseData {
+    isMonorepo: boolean;
+    type: string;
+    rootPath: string;
+    getProjects?: GetProjectsFunc;
+}
+export declare const getMonorepoBaseData: (starFindPath: string, otherMonorepoAnalyzer?: Record<string, MonorepoAnalyzer>) => Promise<IMonorepoBaseData>;

package/dist/common/getProjects.d.ts

@@ -0,0 +1,4 @@
+import type { Project } from '../project.js';
+import type { IMonorepoBaseData } from './getBaseData.js';
+export type GetProjectsFunc = (rootPath: string) => Promise<Project[]> | Project[];
+export declare const getMonorepoSubProjects: (monorepoBaseData: IMonorepoBaseData) => Promise<Project[]>;

package/dist/common/index.d.ts

@@ -0,0 +1,6 @@
+export * from './getBaseData.js';
+export * from './isMonorepo.js';
+export { getMonorepoSubProjects } from './getProjects.js';
+export { getProjects as getPnpmMonorepoSubProjects } from './pnpm.js';
+export { getProjects as getRushMonorepoSubProjects } from './rush.js';
+export type { GetProjectsFunc } from './getProjects.js';

package/dist/common/isMonorepo.d.ts

@@ -0,0 +1,8 @@
+export type IsMonorepoFn = (monorepoRootPath: string) => Promise<boolean> | boolean;
+export type IsMonorepoResult = {
+    isMonorepo: boolean;
+    type: 'rush' | 'pnpm' | string;
+};
+export declare const isPnpmMonorepo: IsMonorepoFn;
+export declare const isRushMonorepo: IsMonorepoFn;
+export declare const isMonorepo: (monorepoRootPath: string, otherMonorepoChecks?: Record<string, IsMonorepoFn>) => Promise<IsMonorepoResult>;

package/dist/common/pnpm.d.ts

@@ -0,0 +1,2 @@
+import { Project } from '../project.js';
+export declare const getProjects: (monorepoRoot: string) => Promise<Project[]>;

package/dist/common/rush.d.ts

@@ -0,0 +1,2 @@
+import { Project } from '../project.js';
+export declare const getProjects: (monorepoRoot: string) => Promise<Project[]>;

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const PNPM_WORKSPACE_FILE = "pnpm-workspace.yaml";
+export declare const RUSH_JSON_FILE = "rush.json";
+export declare const PACKAGE_JSON = "package.json";