gulp смотреть файлы обновления jsdoc - PullRequest
Новая
       12

gulp смотреть файлы обновления jsdoc

0 голосов
/ 01 июня 2018

Я пытаюсь просмотреть некоторые файлы в каталоге и автоматически обновить там документацию с помощью 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 не работает вместе с функцией наблюдения?

1 Ответ

0 голосов
/ 02 июня 2018

Не уверен, что проблема в gulp-jsdoc3.Возможно, вы хотите разделить свою задачу на две задачи.

  1. для задания и

  2. для наблюдателя 

        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 и проверить,задание было начато.

Теперь должно быть проще выяснить, что происходит не так.Если это не работает, проверьте сообщение об ошибке для получения более подробной информации.

...