TypeDoc以及如何仅从几个路径中排除* .d.ts文件

时间:2018-08-23 09:00:44

标签: regex typescript gruntjs documentation typedoc

我有关于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

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

也许还有另一种方法吗?

我看到了this comment,但我不知道为什么-我的typedoc重新编译任务正在忽略该模式。

1 个答案:

答案 0 :(得分:2)

好吧,我还是自己找到了答案...

我需要这样的东西:

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'