TypeDoc 以及如何仅从少数路径中排除 *.d.ts 文件
TypeDoc and how to exclude *.d.ts files only from few paths
我有下一个关于 TypeDoc 的问题。
所以我有一个像这样的 TypeDoc 配置:
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../MyDocumentation/',
name: 'MyApp',
target: 'es5',
exclude: '**/*/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
...some sources...
]
}
}
在我的应用程序中有一些带有 *.ts 文件的路径。重新编译这些文件后,*.d.ts 文件已创建,我想将其排除。
所以为了这个问题的需要,我们假设我的路径是这样的:
- MyApp/Scripts/FolderA/(有几个*.ts文件,例如:fileA.ts)
- MyApp/Scripts/FolderB/(有几个*.ts文件,例如:fileB.ts)
- MyApp/Scripts/FolderC/(有几个*.ts文件,例如:fileC.ts)
现在我的 TypeDoc 配置将所有 *.d.ts 文件从整个应用程序中排除。
我正在尝试排除 *.d.ts 文件,但仅限于我定义的路径,所以我尝试了几种方法来定义我的排除模式:
exclude: 'Scripts/{FolderA,FolderB,FolderC}/*.d.ts'
但它只是忽略了
exclude: '**/*+(FolderA|FolderB|FolderC)/*.d.ts'
但我有一个 Process terminated with code 3. 'FolderB' is not recognized as an internal or external command, operable program or batch file
错误。
exclude: '**/{FolderA,FolderB,FolderC}/*.d.ts'
但它也只是忽略了
exclude: [
'Scripts/FolderA/*.d.ts',
'Scripts/FolderB/*.d.ts',
'Scripts/FolderC/*.d.ts'
]
但它也忽略了...
**/FolderA/*.d.ts
不是忽略而是怎么加几条路径?我的一些路径有一个子文件夹,例如。 **/FolderA/ver1/*.d.ts
这都是因为我需要在我的文档中包含来自 node_modules
的所有 index.d.ts
个文件。我需要参考那些库。
也许还有其他方法可以做到?
我看到了 this comment 但我不知道为什么 - 我的 typedoc 重新编译任务忽略了那个模式。
好的,我自己找到了答案...又一次!
我需要这样的东西:
exclude: [
'**/FolderA/*.d.ts',
'**/FolderA/ver1/*.d.ts',
'**/FolderB/*.d.ts',
'**/FolderC/*.d.ts'
]
现在我必须了解如何仅包含来自 node_module
的 index.d.ts
文件 :D
这是小菜一碟 - 我需要添加到 src
行:'node_modules/*/index.d.ts'
我有下一个关于 TypeDoc 的问题。 所以我有一个像这样的 TypeDoc 配置:
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../MyDocumentation/',
name: 'MyApp',
target: 'es5',
exclude: '**/*/*.d.ts',
excludePrivate: true,
mode: 'file'
},
src: [
...some sources...
]
}
}
在我的应用程序中有一些带有 *.ts 文件的路径。重新编译这些文件后,*.d.ts 文件已创建,我想将其排除。
所以为了这个问题的需要,我们假设我的路径是这样的:
- MyApp/Scripts/FolderA/(有几个*.ts文件,例如:fileA.ts)
- MyApp/Scripts/FolderB/(有几个*.ts文件,例如:fileB.ts)
- MyApp/Scripts/FolderC/(有几个*.ts文件,例如:fileC.ts)
现在我的 TypeDoc 配置将所有 *.d.ts 文件从整个应用程序中排除。
我正在尝试排除 *.d.ts 文件,但仅限于我定义的路径,所以我尝试了几种方法来定义我的排除模式:
exclude: 'Scripts/{FolderA,FolderB,FolderC}/*.d.ts'
但它只是忽略了exclude: '**/*+(FolderA|FolderB|FolderC)/*.d.ts'
但我有一个Process terminated with code 3. 'FolderB' is not recognized as an internal or external command, operable program or batch file
错误。exclude: '**/{FolderA,FolderB,FolderC}/*.d.ts'
但它也只是忽略了exclude: [ 'Scripts/FolderA/*.d.ts', 'Scripts/FolderB/*.d.ts', 'Scripts/FolderC/*.d.ts' ]
但它也忽略了...
**/FolderA/*.d.ts
不是忽略而是怎么加几条路径?我的一些路径有一个子文件夹,例如。**/FolderA/ver1/*.d.ts
这都是因为我需要在我的文档中包含来自 node_modules
的所有 index.d.ts
个文件。我需要参考那些库。
也许还有其他方法可以做到?
我看到了 this comment 但我不知道为什么 - 我的 typedoc 重新编译任务忽略了那个模式。
好的,我自己找到了答案...又一次!
我需要这样的东西:
exclude: [
'**/FolderA/*.d.ts',
'**/FolderA/ver1/*.d.ts',
'**/FolderB/*.d.ts',
'**/FolderC/*.d.ts'
]
现在我必须了解如何仅包含来自 node_module
的 index.d.ts
文件 :D
这是小菜一碟 - 我需要添加到 src
行:'node_modules/*/index.d.ts'