feat: supports specify real config file for bundling types

Author: qmhc

README.md

@@ -304,7 +304,7 @@ type MaybePromise<T> = T | Promise<T>
 
 export type BundleConfig = Omit<
   IExtractorConfigPrepareOptions['configObject'],
-  'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
+  'extends' | 'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
 >
 
 export interface ResolverTransformOutput {
@@ -502,7 +502,15 @@ export interface PluginOptions {
      * @default {}
      * @see https://api-extractor.com/pages/setup/invoking/#invoking-from-a-build-script
      */
-    invokeOptions?: IExtractorInvokeOptions
+    invokeOptions?: IExtractorInvokeOptions,
+    /**
+     * Specify a real api-extractor config file path.
+     * 
+     * When invoking, the configuration will be merged in the order: internal config, file config, `extractorConfig`.
+     * 
+     * @default './api-extractor.json'
+     */
+    configPath?: string
   },
 
   /**

README.zh-CN.md

@@ -321,7 +321,7 @@ type MaybePromise<T> = T | Promise<T>
 
 export type BundleConfig = Omit<
   IExtractorConfigPrepareOptions['configObject'],
-  'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
+  'extends' | 'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
 >
 
 export interface ResolverTransformOutput {
@@ -519,7 +519,15 @@ export interface PluginOptions {
      * @default {}
      * @see https://api-extractor.com/pages/setup/invoking/#invoking-from-a-build-script
      */
-    invokeOptions?: IExtractorInvokeOptions
+    invokeOptions?: IExtractorInvokeOptions,
+    /**
+     * 指定一个真实的 api-extractor 配置文件路径
+     * 
+     * 调用时将会按照内部配置、文件配置、`extractorConfig` 的顺序合并
+     * 
+     * @default './api-extractor.json'
+     */
+    configPath?: string
   },
 
   /**

packages/unplugin-dts/src/core/bundle.ts

@@ -1,11 +1,12 @@
-import { mergeObjects, resolve, tryGetPackageInfo, tryGetPkgPath } from './utils'
+import { ensureAbsolute, mergeObjects, resolve, tryGetPackageInfo, tryGetPkgPath } from './utils'
 
-import type { ExtractorLogLevel, IExtractorInvokeOptions } from '@microsoft/api-extractor'
+import type { ExtractorLogLevel, IConfigFile, IExtractorInvokeOptions } from '@microsoft/api-extractor'
 import type { BundleConfig } from './types'
 
 export interface BundleDtsOptions {
   root: string,
   configPath?: string,
+  tsconfigPath?: string,
   compilerOptions: Record<string, any>,
   outDir: string,
   entryPath: string,
@@ -27,6 +28,7 @@ const dtsRE = /\.d\.(m|c)?tsx?$/
 export async function bundleDtsFiles({
   root,
   configPath,
+  tsconfigPath,
   compilerOptions,
   outDir,
   entryPath,
@@ -38,7 +40,8 @@ export async function bundleDtsFiles({
 }: BundleDtsOptions) {
   const { Extractor, ExtractorConfig } = await import('@microsoft/api-extractor')
 
-  const configObjectFullPath = resolve(root, 'api-extractor.json')
+  configPath = configPath ? ensureAbsolute(configPath, root) : ''
+  const configObjectFullPath = configPath || resolve(root, 'api-extractor.json')
 
   if (!dtsRE.test(fileName)) {
     fileName += '.d.ts'
@@ -49,12 +52,12 @@ export async function bundleDtsFiles({
     compilerOptions = { ...compilerOptions, module: 'ESNext' }
   }
 
-  const configObject = mergeObjects({
+  const configObject: IConfigFile = {
     bundledPackages,
     projectFolder: root,
     mainEntryPointFilePath: entryPath,
     compiler: {
-      tsconfigFilePath: configPath,
+      tsconfigFilePath: tsconfigPath,
       overrideTsconfig: {
         $schema: 'http://json.schemastore.org/tsconfig',
         compilerOptions,
@@ -86,7 +89,15 @@ export async function bundleDtsFiles({
         },
       },
     },
-  }, extractorConfig)
+  }
+
+  if (configPath) {
+    mergeObjects(configObject, ExtractorConfig.loadFile(configPath))
+  }
+
+  if (Object.keys(extractorConfig).length) {
+    mergeObjects(configObject, extractorConfig)
+  }
 
   const config = ExtractorConfig.prepare({
     configObject,

packages/unplugin-dts/src/core/runtime.ts

@@ -457,6 +457,7 @@ export class Runtime {
       extractorConfig,
       bundledPackages,
       invokeOptions,
+      configPath: bundleConfigPath,
     } = isNativeObj(bundleTypes) ? bundleTypes : {}
 
     const cleanPath = (path: string, emittedFiles: Map<string, string>) => {
@@ -675,7 +676,10 @@ export class Runtime {
           const rollup = async (path: string) => {
             const result = await bundleDtsFiles({
               root,
-              configPath,
+              // api-extractor.json
+              configPath: bundleConfigPath,
+              // tsconfig.json
+              tsconfigPath: configPath,
               compilerOptions,
               outDir,
               entryPath: path,

packages/unplugin-dts/src/core/types.ts

@@ -15,7 +15,7 @@ export interface Logger {
 
 export type BundleConfig = Omit<
   IExtractorConfigPrepareOptions['configObject'],
-  'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
+  'extends' | 'projectFolder' | 'mainEntryPointFilePath' | 'bundledPackages'
 >
 
 export type AliasOptions = {
@@ -183,7 +183,15 @@ export interface EmitOptions {
      * @default {}
      * @see https://api-extractor.com/pages/setup/invoking/#invoking-from-a-build-script
      */
-    invokeOptions?: IExtractorInvokeOptions
+    invokeOptions?: IExtractorInvokeOptions,
+    /**
+     * Specify a real api-extractor config file path.
+     * 
+     * When invoking, the configuration will be merged in the order: internal config, file config, `extractorConfig`.
+     * 
+     * @default './api-extractor.json'
+     */
+    configPath?: string
   },
   /**
    * Hook called prior to writing each declaration file.

packages/unplugin-dts/src/core/utils.ts

@@ -85,7 +85,7 @@ export async function unwrapPromise<T>(maybePromise: T | Promise<T>) {
   return isPromise(maybePromise) ? await maybePromise : maybePromise
 }
 
-export function mergeObjects<T extends Record<string, unknown>, U extends Record<string, unknown>>(
+export function mergeObjects<T extends Record<string, any>, U extends Record<string, any>>(
   sourceObj: T,
   targetObj: U,
 ) {