首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >TypeDoc如何定义externalPattern?

TypeDoc如何定义externalPattern?
EN

Stack Overflow用户
提问于 2018-08-20 13:38:43
回答 2查看 729关注 0票数 1

我在用咕噜和打字机做应用程序。

我需要使用TypeDoc编写文档,但有一个方案有问题。

我必须从文档中排除一些文件,这些文件是外部文件库。我不能将这些文件放入exclude部分,因为这些文件与另一个文件有关。如果我试图排除它(通过将这些文件放入exclude部分),我就出现了一个错误--类似于cannot find to xxx into yyy.ts --其中xxx是我排除的元素,yyy是与xxx相关的文件。这些相关的文件在这个文档中是必要的,所以我也不能排除这些文件。

我阅读了TypeDoc关于excludeExternals的文档。所以我想,如果我把这个布尔值设置为true,那么我就可以定义externalPattern来排除我的外部文件。这是可行的,但只有当我把一个文件的名字-没有更多。

你知道怎么做吗?

这是我在gruntfile.js中的类型文件配置(没有excludeExternals选项):

代码语言:javascript
复制
typedoc: {
    build: {
        options: {
            module: 'commonjs',
            out: '../Documentation/',
            name: 'MyApp',
            target: 'es5',
            exclude: [
                'node_modules',
                '**/*.d.ts'
            ],
            excludePrivate: true,
            mode: 'file'
        },
        src: [
            ...some source...
        ]
    }
} 

这是我必须排除的外部文件列表: A.ts,B.ts,C.ts,D.ts .

这是我在gruntfile.js中的typedoc配置(带有excludeExternals选项):

代码语言:javascript
复制
typedoc: {
    build: {
        options: {
            module: 'commonjs',
            out: '../Documentation/',
            name: 'MyApp',
            target: 'es5',
            exclude: [
                'node_modules',
                '**/*.d.ts'
            ],
            excludeExternals: true,
            externalPattern: '**/*/A.ts',
            excludePrivate: true,
            mode: 'file'
        },
        src: [
            ...some source...
        ]
    }
} 

此配置运行良好。我有一个没有A.ts文件的文档。所以现在我需要放几个文件,所以我尝试在externalPattern上放一些类似于:**/*/(A|B|C|D).ts之类的东西,但是没有成功(因为在文档的重新编译过程中,我出现了错误:Process terminated with code 3. 'B' is not recognized as an internal or external command, operable program or batch file.)。

有什么想法吗?

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2018-08-21 07:43:44

我找到了解决办法。如果我想使用externalPattern排除外部文件,我应该编写类似这样的模式:

代码语言:javascript
复制
externalPattern: "**/*/{A,B,C,D}.ts"

{}=允许以逗号分隔的“或”表达式列表。 ,=或

对我有用的是来自gruntfile中regex主题的这句话

票数 1
EN

Stack Overflow用户

发布于 2018-08-20 13:50:10

根据这句话的说法,正确的语法应该是**/*/+(A|B|C|D).ts。此外,看起来您在shell试图解释管道字符时遇到了问题,所以尝试在整个过程中添加双引号:

代码语言:javascript
复制
externalPattern: '"**/*/+(A|B|C|D).ts"'
票数 -1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/51932003

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档