rsbuild-plugin-dts 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+<picture>
+  <img alt="Rslib Banner" src="https://assets.rspack.dev/rslib/rslib-banner.png">
+</picture>
+
+# Rslib
+
+Rslib is a library build tool powered by [Rsbuild](https://rsbuild.dev). It allows library developers to leverage the knowledge and ecosystem of webpack and Rspack.
+
+<!-- ## Documentation
+
+https://rslib.dev/ -->
+
+## Contributing
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/rslib/blob/main/CONTRIBUTING.md).
+
+## License
+
+Rslib is [MIT licensed](https://github.com/web-infra-dev/rslib/blob/main/LICENSE).

package/dist/apiExtractor.cjs

@@ -0,0 +1,94 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var apiExtractor_exports = {};
+__export(apiExtractor_exports, {
+  bundleDts: () => bundleDts
+});
+module.exports = __toCommonJS(apiExtractor_exports);
+var import_node_path = require("node:path");
+var import_api_extractor = require("@microsoft/api-extractor");
+var import_core = require("@rsbuild/core");
+var import_picocolors = __toESM(require("picocolors"));
+var import_utils = require("./utils.cjs");
+async function bundleDts(options) {
+  const {
+    name,
+    cwd,
+    outDir,
+    dtsExtension,
+    dtsEntry = {
+      name: "index",
+      path: "index.d.ts"
+    },
+    tsconfigPath = "tsconfig.json",
+    bundledPackages = []
+  } = options;
+  try {
+    const start = Date.now();
+    const untrimmedFilePath = (0, import_node_path.join)(
+      cwd,
+      (0, import_node_path.relative)(cwd, outDir),
+      `${dtsEntry.name}${dtsExtension}`
+    );
+    const mainEntryPointFilePath = dtsEntry.path;
+    const internalConfig = {
+      mainEntryPointFilePath,
+      bundledPackages,
+      dtsRollup: {
+        enabled: true,
+        untrimmedFilePath
+      },
+      compiler: {
+        tsconfigFilePath: tsconfigPath.includes(cwd) ? tsconfigPath : (0, import_node_path.join)(cwd, tsconfigPath)
+      },
+      projectFolder: cwd
+    };
+    const extractorConfig = import_api_extractor.ExtractorConfig.prepare({
+      configObject: internalConfig,
+      configObjectFullPath: void 0,
+      packageJsonFullPath: (0, import_node_path.join)(cwd, "package.json")
+    });
+    const extractorResult = import_api_extractor.Extractor.invoke(extractorConfig, {
+      localBuild: true
+    });
+    if (!extractorResult.succeeded) {
+      throw new Error(`API Extractor error. ${import_picocolors.default.gray(`(${name})`)}`);
+    }
+    import_core.logger.info(
+      `API Extractor bundle DTS succeeded: ${import_picocolors.default.cyan(untrimmedFilePath)} in ${(0, import_utils.getTimeCost)(start)} ${import_picocolors.default.gray(`(${name})`)}`
+    );
+  } catch (e) {
+    import_core.logger.error("API Extractor Error");
+    throw new Error(`${e}`);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  bundleDts
+});

package/dist/apiExtractor.d.ts

@@ -0,0 +1,11 @@
+import type { DtsEntry } from './';
+export type BundleOptions = {
+    name: string;
+    cwd: string;
+    outDir: string;
+    dtsExtension: string;
+    dtsEntry: DtsEntry;
+    tsconfigPath?: string;
+    bundledPackages?: string[];
+};
+export declare function bundleDts(options: BundleOptions): Promise<void>;

package/dist/apiExtractor.js

@@ -0,0 +1,69 @@
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+var __filename = /* @__PURE__ */ getFilename();
+import { join, relative } from "node:path";
+import {
+  Extractor,
+  ExtractorConfig
+} from "@microsoft/api-extractor";
+import { logger } from "@rsbuild/core";
+import color from "picocolors";
+import { getTimeCost } from "./utils.js";
+async function bundleDts(options) {
+  const {
+    name,
+    cwd,
+    outDir,
+    dtsExtension,
+    dtsEntry = {
+      name: "index",
+      path: "index.d.ts"
+    },
+    tsconfigPath = "tsconfig.json",
+    bundledPackages = []
+  } = options;
+  try {
+    const start = Date.now();
+    const untrimmedFilePath = join(
+      cwd,
+      relative(cwd, outDir),
+      `${dtsEntry.name}${dtsExtension}`
+    );
+    const mainEntryPointFilePath = dtsEntry.path;
+    const internalConfig = {
+      mainEntryPointFilePath,
+      bundledPackages,
+      dtsRollup: {
+        enabled: true,
+        untrimmedFilePath
+      },
+      compiler: {
+        tsconfigFilePath: tsconfigPath.includes(cwd) ? tsconfigPath : join(cwd, tsconfigPath)
+      },
+      projectFolder: cwd
+    };
+    const extractorConfig = ExtractorConfig.prepare({
+      configObject: internalConfig,
+      configObjectFullPath: void 0,
+      packageJsonFullPath: join(cwd, "package.json")
+    });
+    const extractorResult = Extractor.invoke(extractorConfig, {
+      localBuild: true
+    });
+    if (!extractorResult.succeeded) {
+      throw new Error(`API Extractor error. ${color.gray(`(${name})`)}`);
+    }
+    logger.info(
+      `API Extractor bundle DTS succeeded: ${color.cyan(untrimmedFilePath)} in ${getTimeCost(start)} ${color.gray(`(${name})`)}`
+    );
+  } catch (e) {
+    logger.error("API Extractor Error");
+    throw new Error(`${e}`);
+  }
+}
+export {
+  bundleDts
+};

package/dist/dts.cjs

@@ -0,0 +1,205 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var dts_exports = {};
+__export(dts_exports, {
+  calcBundledPackages: () => calcBundledPackages,
+  generateDts: () => generateDts
+});
+module.exports = __toCommonJS(dts_exports);
+var import_node_fs = __toESM(require("node:fs"));
+var import_node_path = require("node:path");
+var import_core = require("@rsbuild/core");
+var import_picocolors = __toESM(require("picocolors"));
+var ts = __toESM(require("typescript"));
+var import_tsc = require("./tsc.cjs");
+var import_utils = require("./utils.cjs");
+const isObject = (obj) => Object.prototype.toString.call(obj) === "[object Object]";
+const calcBundledPackages = (options) => {
+  const { autoExternal, cwd, userExternals } = options;
+  let pkgJson;
+  try {
+    const content = import_node_fs.default.readFileSync((0, import_node_path.join)(cwd, "package.json"), "utf-8");
+    pkgJson = JSON.parse(content);
+  } catch (err) {
+    import_core.logger.warn(
+      "The type of third-party packages will not be bundled due to read package.json failed"
+    );
+    return [];
+  }
+  const externalOptions = autoExternal ? {
+    dependencies: true,
+    peerDependencies: true,
+    devDependencies: false,
+    ...autoExternal === true ? {} : autoExternal
+  } : {
+    dependencies: false,
+    peerDependencies: false,
+    devDependencies: false
+  };
+  const getUserExternalsKeys = (value) => {
+    if (!value) {
+      return [];
+    }
+    if (typeof value === "string" || value instanceof RegExp) {
+      return [value];
+    }
+    if (Array.isArray(value)) {
+      return value.flatMap((v) => getUserExternalsKeys(v));
+    }
+    if (isObject(userExternals)) {
+      return Object.keys(userExternals);
+    }
+    return [];
+  };
+  const externals = getUserExternalsKeys(userExternals);
+  const allDeps = [];
+  for (const type of [
+    "dependencies",
+    "peerDependencies",
+    "devDependencies"
+  ]) {
+    const deps = pkgJson[type] && Object.keys(pkgJson[type]);
+    if (deps) {
+      if (externalOptions[type]) {
+        externals.push(...deps);
+      }
+      allDeps.push(...deps);
+    }
+  }
+  const bundledPackages = allDeps.filter(
+    (d) => !externals.some((e) => typeof e === "string" ? d === e : e.test(d))
+  );
+  return Array.from(new Set(bundledPackages));
+};
+async function generateDts(data) {
+  const {
+    bundle,
+    distPath,
+    dtsEntry,
+    tsconfigPath,
+    name,
+    cwd,
+    isWatch,
+    dtsExtension = ".d.ts",
+    autoExternal = true,
+    userExternals
+  } = data;
+  import_core.logger.start(`Generating DTS... ${import_picocolors.default.gray(`(${name})`)}`);
+  const configPath = ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath);
+  if (!configPath) {
+    import_core.logger.error(`tsconfig.json not found in ${cwd}`);
+    throw new Error();
+  }
+  const { options: rawCompilerOptions, fileNames } = (0, import_utils.loadTsconfig)(configPath);
+  const rootDir = rawCompilerOptions.rootDir ?? await (0, import_utils.calcLongestCommonPath)(fileNames) ?? (0, import_node_path.dirname)(configPath);
+  const outDir = distPath ? distPath : rawCompilerOptions.declarationDir || "./dist";
+  const getDeclarationDir = (bundle2, distPath2) => {
+    if (bundle2) {
+      return (0, import_utils.ensureTempDeclarationDir)(cwd);
+    }
+    return distPath2 ? distPath2 : rawCompilerOptions.declarationDir ?? "./dist";
+  };
+  const declarationDir = getDeclarationDir(bundle, distPath);
+  const { name: entryName, path: entryPath } = dtsEntry;
+  let entry = "";
+  if (bundle === true && entryPath) {
+    const entrySourcePath = (0, import_node_path.join)(cwd, entryPath);
+    const relativePath = (0, import_node_path.relative)(rootDir, (0, import_node_path.dirname)(entrySourcePath));
+    entry = (0, import_node_path.join)(
+      declarationDir,
+      relativePath,
+      (0, import_node_path.basename)(entrySourcePath)
+    ).replace(
+      /\.(js|mjs|jsx|ts|mts|tsx|cjs|cts|cjsx|ctsx|mjsx|mtsx)$/,
+      ".d.ts"
+    );
+  }
+  const bundleDtsIfNeeded = async () => {
+    if (bundle === true) {
+      const { bundleDts } = await Promise.resolve().then(() => __toESM(require("./apiExtractor.cjs")));
+      await bundleDts({
+        name,
+        cwd,
+        outDir,
+        dtsEntry: {
+          name: entryName,
+          path: entry
+        },
+        tsconfigPath,
+        dtsExtension,
+        bundledPackages: calcBundledPackages({
+          autoExternal,
+          cwd,
+          userExternals
+        })
+      });
+    }
+  };
+  const onComplete = async (isSuccess) => {
+    if (isSuccess) {
+      await bundleDtsIfNeeded();
+    }
+  };
+  await (0, import_tsc.emitDts)(
+    {
+      name,
+      cwd,
+      configPath,
+      declarationDir,
+      dtsExtension
+    },
+    onComplete,
+    bundle,
+    isWatch
+  );
+  if (!isWatch) {
+    await bundleDtsIfNeeded();
+  }
+}
+process.on("message", async (data) => {
+  if (!data.cwd) {
+    return;
+  }
+  try {
+    await generateDts(data);
+  } catch (e) {
+    import_core.logger.error(e);
+    process.send("error");
+    process.exit(1);
+  }
+  process.send("success");
+  if (!data.isWatch) {
+    process.exit();
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  calcBundledPackages,
+  generateDts
+});

package/dist/dts.d.ts

@@ -0,0 +1,7 @@
+import type { DtsGenOptions } from './';
+export declare const calcBundledPackages: (options: {
+    autoExternal: DtsGenOptions["autoExternal"];
+    cwd: string;
+    userExternals?: DtsGenOptions["userExternals"];
+}) => string[];
+export declare function generateDts(data: DtsGenOptions): Promise<void>;

package/dist/dts.js

@@ -0,0 +1,180 @@
+import { fileURLToPath } from "url";
+import path from "path";
+var getFilename = () => fileURLToPath(import.meta.url);
+var getDirname = () => path.dirname(getFilename());
+var __dirname = /* @__PURE__ */ getDirname();
+var __filename = /* @__PURE__ */ getFilename();
+import fs from "node:fs";
+import { basename, dirname, join, relative } from "node:path";
+import { logger } from "@rsbuild/core";
+import color from "picocolors";
+import * as ts from "typescript";
+import { emitDts } from "./tsc.js";
+import {
+  calcLongestCommonPath,
+  ensureTempDeclarationDir,
+  loadTsconfig
+} from "./utils.js";
+const isObject = (obj) => Object.prototype.toString.call(obj) === "[object Object]";
+const calcBundledPackages = (options) => {
+  const { autoExternal, cwd, userExternals } = options;
+  let pkgJson;
+  try {
+    const content = fs.readFileSync(join(cwd, "package.json"), "utf-8");
+    pkgJson = JSON.parse(content);
+  } catch (err) {
+    logger.warn(
+      "The type of third-party packages will not be bundled due to read package.json failed"
+    );
+    return [];
+  }
+  const externalOptions = autoExternal ? {
+    dependencies: true,
+    peerDependencies: true,
+    devDependencies: false,
+    ...autoExternal === true ? {} : autoExternal
+  } : {
+    dependencies: false,
+    peerDependencies: false,
+    devDependencies: false
+  };
+  const getUserExternalsKeys = (value) => {
+    if (!value) {
+      return [];
+    }
+    if (typeof value === "string" || value instanceof RegExp) {
+      return [value];
+    }
+    if (Array.isArray(value)) {
+      return value.flatMap((v) => getUserExternalsKeys(v));
+    }
+    if (isObject(userExternals)) {
+      return Object.keys(userExternals);
+    }
+    return [];
+  };
+  const externals = getUserExternalsKeys(userExternals);
+  const allDeps = [];
+  for (const type of [
+    "dependencies",
+    "peerDependencies",
+    "devDependencies"
+  ]) {
+    const deps = pkgJson[type] && Object.keys(pkgJson[type]);
+    if (deps) {
+      if (externalOptions[type]) {
+        externals.push(...deps);
+      }
+      allDeps.push(...deps);
+    }
+  }
+  const bundledPackages = allDeps.filter(
+    (d) => !externals.some((e) => typeof e === "string" ? d === e : e.test(d))
+  );
+  return Array.from(new Set(bundledPackages));
+};
+async function generateDts(data) {
+  const {
+    bundle,
+    distPath,
+    dtsEntry,
+    tsconfigPath,
+    name,
+    cwd,
+    isWatch,
+    dtsExtension = ".d.ts",
+    autoExternal = true,
+    userExternals
+  } = data;
+  logger.start(`Generating DTS... ${color.gray(`(${name})`)}`);
+  const configPath = ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath);
+  if (!configPath) {
+    logger.error(`tsconfig.json not found in ${cwd}`);
+    throw new Error();
+  }
+  const { options: rawCompilerOptions, fileNames } = loadTsconfig(configPath);
+  const rootDir = rawCompilerOptions.rootDir ?? await calcLongestCommonPath(fileNames) ?? dirname(configPath);
+  const outDir = distPath ? distPath : rawCompilerOptions.declarationDir || "./dist";
+  const getDeclarationDir = (bundle2, distPath2) => {
+    if (bundle2) {
+      return ensureTempDeclarationDir(cwd);
+    }
+    return distPath2 ? distPath2 : rawCompilerOptions.declarationDir ?? "./dist";
+  };
+  const declarationDir = getDeclarationDir(bundle, distPath);
+  const { name: entryName, path: entryPath } = dtsEntry;
+  let entry = "";
+  if (bundle === true && entryPath) {
+    const entrySourcePath = join(cwd, entryPath);
+    const relativePath = relative(rootDir, dirname(entrySourcePath));
+    entry = join(
+      declarationDir,
+      relativePath,
+      basename(entrySourcePath)
+    ).replace(
+      /\.(js|mjs|jsx|ts|mts|tsx|cjs|cts|cjsx|ctsx|mjsx|mtsx)$/,
+      ".d.ts"
+    );
+  }
+  const bundleDtsIfNeeded = async () => {
+    if (bundle === true) {
+      const { bundleDts } = await import("./apiExtractor.js");
+      await bundleDts({
+        name,
+        cwd,
+        outDir,
+        dtsEntry: {
+          name: entryName,
+          path: entry
+        },
+        tsconfigPath,
+        dtsExtension,
+        bundledPackages: calcBundledPackages({
+          autoExternal,
+          cwd,
+          userExternals
+        })
+      });
+    }
+  };
+  const onComplete = async (isSuccess) => {
+    if (isSuccess) {
+      await bundleDtsIfNeeded();
+    }
+  };
+  await emitDts(
+    {
+      name,
+      cwd,
+      configPath,
+      declarationDir,
+      dtsExtension
+    },
+    onComplete,
+    bundle,
+    isWatch
+  );
+  if (!isWatch) {
+    await bundleDtsIfNeeded();
+  }
+}
+process.on("message", async (data) => {
+  if (!data.cwd) {
+    return;
+  }
+  try {
+    await generateDts(data);
+  } catch (e) {
+    logger.error(e);
+    process.send("error");
+    process.exit(1);
+  }
+  process.send("success");
+  if (!data.isWatch) {
+    process.exit();
+  }
+});
+export {
+  calcBundledPackages,
+  generateDts
+};