Выход JSDoc несовместим между gulp-jsdoc и стандартом CLI

Question

Я пытаюсь создать документы для простого набора JS-кода (см. Ниже). Если я использую gulp, документы создаются так, как я ожидал бы их. Если я использую CLI, документы являются неполными.

Вот мой JS код:

// BASE.js 
/** @module BASE */ 
var BASE = {}; 

// MOD1.js 
/** @class MOD1 - Test module */ 
BASE.MOD1 = Object.create({}); 

/** 
* Just a test function 
* @param {Object} var1 - A test variable 
*/ 
BASE.MOD1.testFunction = function(var1){ 
    alert('hi'); 
}; 

Мой глотком файл:

var gulp = require('gulp'), 
    jsdoc = require('gulp-jsdoc'), 
    outDir = './gulp-docs/', 
    docInfo = {}, 
    docOptions = {}, 
    docTemplate = {}, 
    srcFiles = [ 
     "BASE.js", 
     "MOD1.js" 
    ]; 

gulp.task('default', function() { 
    return gulp.src(srcFiles) 
      .pipe(jsdoc.parser(docInfo)) 
      .pipe(jsdoc.generator(outDir, docTemplate, docOptions)) 
}); 

И моя командная строка:

C:\DocTest> jsdoc BASE.js MOD1.js --configure rawconf.json --destination raw-docs 

rawconf.json:

{ 
    "tags": { 
     "allowUnknownTags": true 
    }, 
    "plugins": [], 
    "templates": {}, 
    "opts": { 
     "package": "./rawpackage.json" 
    } 
} 

rawpackage.json:

{} 

Я бегу как глотка и команду JSDoc из командной строки Node.js.

Выход из глотка является следующие файлы:

BASE.js.html 
BASE.MOD1.html 
index.html 
MOD1.js.html 
module-BASE.html 

Выход из режима командной строки следующие файлы:

BASE.js.html 
index.html 
MOD1.js.html 
module-BASE.html 
module-BASE-BASE.MOD1.html 

Есть некоторые небольшие различия, которые я могу меловые до различий между gulp-jsoc версии jsdoc (3.3.0-alpha5) и текущей версии (3.3.0-beta3).

Но самое большое различие заключается в том, что в то время как в выводе gulp я могу найти информацию о testFunction, нет никакой информации, касающейся testFunction в любом месте выхода CLI. Я даже искал код HTML - ничего.

Так я сделал что-то не так? Я просто пытаюсь достичь паритета на этом этапе, и я исчерпал любую документацию, которую я мог найти в Интернете.

Answer 1

Если вы посмотрите на страницу galub gulp-jsdoc here, есть «предупреждение о большом жире», что этот плагин не обновляется.

Попробуйте использовать плагин gulp-shell. Вы можете использовать именно то, что вы ввели в командной строке.