gulp 观看文件更新jsdoc

Question

我正在尝试查看目录中的一些文件并使用 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 功能一起使用吗？

Answer 1

不确定问题来自gulp-jsdoc3。也许您想将您的任务分成两个任务。

工作任务和

对于观察者

    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 并且 files to watch src 不应与输出目标文件相同。

您现在可以看到 consol.log 并检查任务是否已启动。

现在应该更容易找出问题所在。如果它不起作用，请查看错误消息以了解更多详细信息。

gulp 观看文件更新jsdoc

gulp watch files update jsdoc

javascript

jsdoc3

gulp