每个人身体的好时光,
我创建了一个应该创建tsdocs的gulp任务,这就是它的样子。
'use strict';
var gulp = require('gulp'),
helpers = require('../helpers/gulp-helpers')(),
plugins = require('gulp-load-plugins')(),
env = require('./gulp.env');
function typedoc() {
return gulp.src([
'src/scripts/**/*!(.spec).ts',
'!src/scripts/**/*.spec.ts',
...env.settings.typings
]).pipe(plugins.typedoc({
module: 'commonjs',
target: 'es5',
experimentalDecorators: true,
ignoreCompilerErrors: false,
version: true,
out: 'docs'
})).on("error", (error) => {
if (error.plugin && error.message) {
// it is a gulp plugin error
helpers.log("Error in plugin: " + error.plugin);
helpers.log(error.message);
}
else {
// some other error
helpers.log(error);
}
exitCode++;
}) // make exit code non-zero
}
// Workaround: directly calling process.exit() has corner cases where
// the console.log statements are not flushed (namely if stdout is piped
// instead of goes to a terminal).
let exitCode = 0;
process.on("exit", function() {
if (exitCode != 0) process.exit(exitCode);
});
gulp.task('ts:docs', typedoc);
当我运行它时,它会失败,并显示以下错误列表:
TypeDoc 0.3.12
Using TypeScript 1.6.2 from /Users//private/cms/node_modules/typedoc/node_modules/typescript/lib
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(84)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(179)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(180)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(181)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(182)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(183)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(184)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(226)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(227)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(228)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(229)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(230)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(471)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(472)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(473)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(474)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(475)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(476)
Type expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1836)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1837)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1838)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1838)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1848)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1849)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1850)
'=' expected.
[11:04:35] /Users//private/cms/typings/main/ambient/node/index.d.ts(1850)
'=' expected.
[11:04:35] Error in plugin: gulp-typedoc
[11:04:35] Failed to generate load TypeDoc project.
[11:04:35] 'ts:docs' errored after 889 ms
[11:04:35] Error in plugin 'gulp-typedoc'
Message:
Failed to generate load TypeDoc project.
答案 0 :(得分:4)
Typedoc
未更新typescript
的(依赖模块)npm
版本。所以你只需打开项目中typedoc
文件夹中的node_modules
文件夹,然后编辑package.json
文件,如下所示。
"typescript": "1.6.2"
至"typescript": "1.8.10"
然后对npm i
项目运行typedoc
命令。
之后,您可以运行docs生成脚本。它会正常工作。