@rsbuild/plugin-source-build 1.0.0 → 1.0.1-beta.0

package/dist/plugin.d.ts

@@ -0,0 +1,23 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+import type { Project } from './project';
+import { type ExtraMonorepoStrategies } from './project-utils';
+export declare const PLUGIN_SOURCE_BUILD_NAME = "rsbuild:source-build";
+export declare const getSourceInclude: (options: {
+    projects: Project[];
+    sourceField: string;
+}) => Promise<string[]>;
+export interface PluginSourceBuildOptions {
+    /**
+     * Used to configure the resolve field of the source code files.
+     * @default 'source''
+     */
+    sourceField?: string;
+    /**
+     * Whether to read source code or output code first.
+     * @default 'source'
+     */
+    resolvePriority?: 'source' | 'output';
+    projectName?: string;
+    extraMonorepoStrategies?: ExtraMonorepoStrategies;
+}
+export declare function pluginSourceBuild(options?: PluginSourceBuildOptions): RsbuildPlugin;

package/dist/project-utils/filter.d.ts

@@ -0,0 +1,4 @@
+import type { Project } from '../project';
+export type Filter = FilterFunction;
+export type FilterFunction = (projects: Project[]) => Project[] | Promise<Project[]>;
+export declare const filterByField: (fieldName: string, checkExports?: boolean) => FilterFunction;

package/dist/project-utils/getDependentProjects.d.ts

@@ -0,0 +1,12 @@
+import type { Project } from '../project';
+import type { MonorepoAnalyzer } from '../types';
+import type { Filter } from './filter';
+export type ExtraMonorepoStrategies = Record<string, MonorepoAnalyzer>;
+export interface GetDependentProjectsOptions {
+    cwd?: string;
+    recursive?: boolean;
+    filter?: Filter;
+    extraMonorepoStrategies?: ExtraMonorepoStrategies;
+}
+declare const getDependentProjects: (projectNameOrRootPath: string, options: GetDependentProjectsOptions) => Promise<Project[]>;
+export { getDependentProjects };

package/dist/project-utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './getDependentProjects';
+export * from './filter';

package/dist/project.d.ts

@@ -0,0 +1,18 @@
+import type { INodePackageJson } from './types/packageJson';
+export declare class Project {
+    #private;
+    name: string;
+    dir: string;
+    metaData: INodePackageJson;
+    constructor(name: string, dir: string);
+    init(): Promise<void>;
+    getMetaData(): INodePackageJson;
+    getDependentProjects(monorepoProjects: Project[], options?: {
+        recursive?: boolean;
+    }): Project[];
+    getDirectDependentProjects(allProjectMap: Map<string, Project>): Project[];
+    getSourceEntryPaths(options?: {
+        field?: string;
+        exports?: boolean;
+    }): string[];
+}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+import type { GetProjectsFunc } from '../common/getProjects';
+import type { IsMonorepoFn } from '../common/isMonorepo';
+export * from './packageJson';
+export * from './rushJson';
+export interface MonorepoAnalyzer {
+    check: IsMonorepoFn;
+    getProjects: GetProjectsFunc;
+}
+export interface IPnpmWorkSpace {
+    packages: string[];
+}
+export type TsConfig = {
+    references?: Array<{
+        path?: string;
+    }>;
+};

package/dist/types/packageJson.d.ts

@@ -0,0 +1,152 @@
+/**
+ * The following code is modified based on
+ * https://github.com/microsoft/rushstack/blob/main/libraries/node-core-library/src/IPackageJson.ts
+ *
+ * MIT Licensed
+ * Copyright (c) Microsoft Corporation
+ * https://github.com/microsoft/rushstack/blob/main/LICENSE
+ */
+/**
+ * This interface is part of the {@link IPackageJson} file format.  It is used for the
+ * "dependencies", "optionalDependencies", and "devDependencies" fields.
+ * @public
+ */
+export interface IPackageJsonDependencyTable {
+    /**
+     * The key is the name of a dependency.  The value is a Semantic Versioning (SemVer)
+     * range specifier.
+     */
+    [dependencyName: string]: string;
+}
+export interface IPackageJsonRepository {
+    /**
+     * The source control type for the repository that hosts the project. This is typically "git".
+     */
+    type: string;
+    /**
+     * The URL of the repository that hosts the project.
+     */
+    url: string;
+    /**
+     * If the project does not exist at the root of the repository, its path is specified here.
+     */
+    directory?: string;
+}
+/**
+ * This interface is part of the {@link IPackageJson} file format.  It is used for the
+ * "scripts" field.
+ * @public
+ */
+export interface IPackageJsonScriptTable {
+    /**
+     * The key is the name of the script hook.  The value is the script body which may
+     * be a file path or shell script command.
+     */
+    [scriptName: string]: string;
+}
+/**
+ * This interface is part of the {@link IPackageJson} file format. It is used for the
+ * "peerDependenciesMeta" field.
+ * @public
+ */
+export interface IPeerDependenciesMetaTable {
+    [dependencyName: string]: {
+        optional?: boolean;
+    };
+}
+export type ExportsModuleRules = string | Record<string, string> | Record<string, string | Record<string, string>>;
+export interface ExportsConfig {
+    [modulePath: string]: ExportsModuleRules;
+}
+export interface INodePackageJson {
+    /**
+     * The name of the package.
+     */
+    name: string;
+    /**
+     * A version number conforming to the Semantic Versioning (SemVer) standard.
+     */
+    version?: string;
+    /**
+     * Indicates whether this package is allowed to be published or not.
+     */
+    private?: boolean;
+    /**
+     * A brief description of the package.
+     */
+    description?: string;
+    /**
+     * The URL of the project's repository.
+     */
+    repository?: string | IPackageJsonRepository;
+    /**
+     * The URL to the project's web page.
+     */
+    homepage?: string;
+    /**
+     * The name of the license.
+     */
+    license?: string;
+    /**
+     * The path to the module file that will act as the main entry point.
+     */
+    main?: string;
+    exports?: ExportsConfig;
+    /**
+     * The path to the TypeScript *.d.ts file describing the module file
+     * that will act as the main entry point.
+     */
+    types?: string;
+    /**
+     * Alias for `types`
+     */
+    typings?: string;
+    /**
+     * The path to the TSDoc metadata file.
+     * This is still being standardized: https://github.com/microsoft/tsdoc/issues/7#issuecomment-442271815
+     * @beta
+     */
+    tsdocMetadata?: string;
+    /**
+     * The main entry point for the package.
+     */
+    bin?: string;
+    /**
+     * An array of dependencies that must always be installed for this package.
+     */
+    dependencies?: IPackageJsonDependencyTable;
+    /**
+     * An array of optional dependencies that may be installed for this package.
+     */
+    optionalDependencies?: IPackageJsonDependencyTable;
+    /**
+     * An array of dependencies that must only be installed for developers who will
+     * build this package.
+     */
+    devDependencies?: IPackageJsonDependencyTable;
+    /**
+     * An array of dependencies that must be installed by a consumer of this package,
+     * but which will not be automatically installed by this package.
+     */
+    peerDependencies?: IPackageJsonDependencyTable;
+    /**
+     * An array of metadata about peer dependencies.
+     */
+    peerDependenciesMeta?: IPeerDependenciesMetaTable;
+    /**
+     * A table of script hooks that a package manager or build tool may invoke.
+     */
+    scripts?: IPackageJsonScriptTable;
+    /**
+     * A table of package version resolutions. This feature is only implemented by the Yarn package manager.
+     *
+     * @remarks
+     * See the {@link https://github.com/yarnpkg/rfcs/blob/master/implemented/0000-selective-versions-resolutions.md
+     * | 0000-selective-versions-resolutions.md RFC} for details.
+     */
+    resolutions?: Record<string, string>;
+}
+export interface IPackageJson extends INodePackageJson {
+    /** {@inheritDoc INodePackageJson.version} */
+    version: string;
+}

package/dist/types/rushJson.d.ts

@@ -0,0 +1,7 @@
+export interface RushConfigurationProject {
+    readonly packageName: string;
+    readonly projectFolder: string;
+}
+export interface IRushConfig {
+    projects?: RushConfigurationProject[];
+}

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import type { INodePackageJson, IRushConfig } from './types';
+export declare const readPackageJson: (pkgJsonFilePath: string) => Promise<INodePackageJson>;
+export declare const readRushJson: (rushJsonFilePath: string) => Promise<IRushConfig>;
+export declare const readJson: <T>(jsonFileAbsPath: string) => Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/plugin-source-build",
-  "version": "1.0.0",
+  "version": "1.0.1-beta.0",
   "description": "Source build plugin of Rsbuild",
   "homepage": "https://rsbuild.dev",
   "repository": {
@@ -9,31 +9,32 @@
     "directory": "packages/plugin-source-build"
   },
   "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "default": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@rsbuild/monorepo-utils": "1.0.0",
-    "@rsbuild/shared": "1.0.0"
+    "fast-glob": "^3.3.2",
+    "json5": "^2.2.3"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.2",
-    "typescript": "^5.3.0",
-    "@rsbuild/core": "1.0.0",
-    "@rsbuild/test-helper": "1.0.0",
-    "@rsbuild/webpack": "1.0.0"
+    "typescript": "^5.5.2",
+    "yaml": "^2.4.5",
+    "@rsbuild/core": "1.0.1-beta.0",
+    "@rsbuild/plugin-babel": "1.0.1-beta.0",
+    "@scripts/test-helper": "1.0.1-beta.0"
   },
   "peerDependencies": {
-    "@rsbuild/core": "^1.0.0"
+    "@rsbuild/core": "^1.0.1-beta.0"
   },
   "publishConfig": {
     "access": "public",

package/dist/index.mjs

@@ -1,80 +0,0 @@
-// ../../node_modules/.pnpm/@modern-js+module-tools@2.40.0_typescript@5.3.2/node_modules/@modern-js/module-tools/shims/esm.js
-import { fileURLToPath } from "url";
-import path from "path";
-
-// ../../scripts/require_shims.js
-import { createRequire } from "module";
-global.require = createRequire(import.meta.url);
-
-// src/index.ts
-import fs from "fs";
-import path2 from "path";
-import { TS_CONFIG_FILE } from "@rsbuild/shared";
-import {
-  filterByField,
-  getDependentProjects
-} from "@rsbuild/monorepo-utils";
-var pluginName = "rsbuild:source-build";
-var getSourceInclude = async (options) => {
-  const { projects, sourceField } = options;
-  const includes = [];
-  for (const project of projects) {
-    includes.push(...project.getSourceEntryPaths({ field: sourceField }));
-  }
-  return includes;
-};
-function pluginSourceBuild(options) {
-  const {
-    projectName,
-    sourceField = "source",
-    extraMonorepoStrategies
-  } = options ?? {};
-  return {
-    name: pluginName,
-    setup(api) {
-      const projectRootPath = api.context.rootPath;
-      let projects = [];
-      api.modifyRsbuildConfig(async (config) => {
-        projects = await getDependentProjects(projectName || projectRootPath, {
-          cwd: projectRootPath,
-          recursive: true,
-          filter: filterByField(sourceField),
-          extraMonorepoStrategies
-        });
-        const includes = await getSourceInclude({
-          projects,
-          sourceField
-        });
-        config.source = config.source ?? {};
-        config.source.include = [...config.source.include ?? [], ...includes];
-      });
-      if (api.context.bundlerType === "webpack") {
-        api.modifyWebpackChain((chain, { CHAIN_ID }) => {
-          const {
-            tools: { tsLoader }
-          } = api.getNormalizedConfig();
-          const useTsLoader = Boolean(tsLoader);
-          chain.module.rule(useTsLoader ? CHAIN_ID.RULE.TS : CHAIN_ID.RULE.JS).resolve.mainFields.merge([sourceField, "..."]);
-          chain.module.rule(useTsLoader ? CHAIN_ID.RULE.TS : CHAIN_ID.RULE.JS).resolve.merge({
-            conditionNames: ["...", sourceField]
-          });
-          const { TS_CONFIG_PATHS } = CHAIN_ID.RESOLVE_PLUGIN;
-          if (chain.resolve.plugins.has(TS_CONFIG_PATHS)) {
-            chain.resolve.plugin(TS_CONFIG_PATHS).tap((options2) => {
-              const references = projects.map((project) => path2.join(project.dir, TS_CONFIG_FILE)).filter((filePath) => fs.existsSync(filePath));
-              return options2.map((option) => ({
-                ...option,
-                references
-              }));
-            });
-          }
-        });
-      }
-    }
-  };
-}
-export {
-  getSourceInclude,
-  pluginName,
-  pluginSourceBuild
-};