undefined
配置 TypeScript 声明文件的生成。
类型声明文件生成是一个可选功能,你可以设置 dts: true
来启用 bundleless 类型 生成。
如果你想要禁用类型声明文件生成,可以设置 dts: false
或者不指定 dts
选项。
如果你想要自定义类型声明文件的生成,可以将 dts
选项设置为一个对象。
boolean | { bundledPackages?: string[] }
false
是否打包类型声明文件。
如果你想要 bundle 类型,你需要:
dts.bundle
设置为 true
。string[]
用于指定需要打包类型声明文件的依赖项,该配置将传递给 @microsoft/api-extractor
的 bundledPackages 配置项。
默认情况下,Rslib 会根据以下配置确定需要外部化的依赖项,详见 处理第三方依赖。
那些没有被外部化的直接依赖项(在 package.json
中声明)会被添加到 bundledPackages
中,这些包的类型声明文件将会被打包到最终的产物中。
当默认行为不能满足需求时,可以通过 dts.bundle.bundledPackages
显式指定需要打包的依赖项。设置该配置后,将完全覆盖上述默认行为。
该配置通常用于打包传递依赖项(即直接依赖的依赖)。假设项目直接依赖 foo
,而 foo
又依赖 bar
,如果需要同时打包 foo
和 bar
的类型声明文件,可以如下配置:
bundledPackages
可以使用 minimatch 语法配置 glob 表达式,但仅会匹配 package.json
中已声明的直接依赖项。
string
类型声明文件的输出目录。
默认值按照以下优先级确定:
dts.distPath
值。tsconfig.json
文件中的 declarationDir
值。boolean
false
是否在生成类型声明文件时构建项目的 references。这相当于在 tsc
命令中使用 --build
标志。更多详细信息请参考 项目引用。
当启用此选项时,你必须在 tsconfig.json
中显式设置 declarationDir
或 outDir
以满足构建要求。
boolean
true
当类型声明文件生成过程中出现错误时,是否中止构建过程。
默认情况下,类型错误会导致构建失败。
当 abortOnError
设置为 false
时(如下所示),即使代码中存在类型问题,构建仍然会成功。
当禁用该配置时,无法保证类型文件会被正确生成。
boolean
false
是否根据 format 选项自动设置类型声明文件扩展名。
当 dts.autoExtension
为 false
时,类型声明文件扩展名默认为 .d.ts
。
当 dts.autoExtension
设置为 true
时,类型声明文件扩展名将会是:
当 package.json
中设置 type: module
时,esm
格式使用 .d.ts
,cjs
格式使用 .d.cts
。
当 package.json
中设置 type: commonjs
或没有 type
字段时,cjs
格式使用 .d.ts
,esm
格式使用 .d.mts
。
这遵循与 lib.autoExtension 相同的逻辑,但默认值不同,因为类型声明文件扩展名可能会在不同的模块解析策略中造成一些问题。