TypeDoc 以及如何仅从少数路径中排除 *.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 文件,但仅限于我定义的路径,所以我尝试了几种方法来定义我的排除模式:

  1. exclude: 'Scripts/{FolderA,FolderB,FolderC}/*.d.ts'但它只是忽略
  2. 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错误。
  3. exclude: '**/{FolderA,FolderB,FolderC}/*.d.ts'但它只是忽略了
  4. exclude: [
    'Scripts/FolderA/*.d.ts',
    'Scripts/FolderB/*.d.ts',
    'Scripts/FolderC/*.d.ts'
    ]
    

    但它也忽略了...

  5. **/FolderA/*.d.ts不是忽略,但如何添加一些路径?我的一些路径有一个子文件夹,例如。**/FolderA/ver1/*.d.ts

这就是全部,因为我需要将node_modules中的所有index.d.ts文件包含在我的文档中。我需要参考这些库。

也许还有另一种方法可以做到这一点?

我看到了这条评论,但我不知道为什么 - 我的 typedoc 重新编译任务忽略了这种模式。

好的,我自己找到了答案...再!

我需要这样的东西:

exclude: [
'**/FolderA/*.d.ts',
'**/FolderA/ver1/*.d.ts',
'**/FolderB/*.d.ts',
'**/FolderC/*.d.ts'
]

现在我必须如何仅包含index.d.ts文件中的文件node_module:D


这是小菜一碟 - 我需要添加到src行中:'node_modules/*/index.d.ts'

最新更新