我正在尝试查看目录中的某些文件,并使用jsdoc自动更新文档。我使用gulp来查看文件并运行jsdoc,参见下面的代码。
const gulp = require('gulp');
const watch = require('gulp-watch');
const jsdoc = require('gulp-jsdoc3');
gulp.task('doc', function(cb) {
const config = require('./jsdoc.json');
return watch(['../upload/**/*.js'], { ignoreInitial: false })
.pipe(jsdoc(config, cb));
});
当我运行此任务时,它不会在更改文件时更新我的jsdoc。 jsdoc不能与watch功能一起使用吗?
答案 0 :(得分:0)
不确定问题来自gulp-jsdoc3。也许你想把你的任务分成两个任务。
B2:B17
请注意观察者没有 const gulp = require('gulp');
const watch = require('gulp-watch');
const jsdoc = require('gulp-jsdoc3');
gulp.task('jsdoc-task', function() {
console.log('task is running')
const config = require('./jsdoc.json');
return gulp.src( 'scr/files' )
.pipe(jsdoc(config)).
.pipe(gulp.dest( 'your destination path ));
});
gulp.task('watch', function() {
gulp.watch('files-to-watch', [jsdoc-task]);
});
,return
src也不应与输出目标文件相同。
您现在可以看到files to watch
并查看任务是否已启动。
现在应该更容易找出问题所在。如果不起作用,请查看错误消息以获取更多详细信息。