55 lines
1.8 KiB
JavaScript
55 lines
1.8 KiB
JavaScript
"use strict";
|
|
/* ------------------------------------------
|
|
* This module creates TypeScript documentation
|
|
* -------------------------------------------- */
|
|
const q = require("q");
|
|
const paths = require("../npmts.paths");
|
|
const npmts_log_1 = require("../npmts.log");
|
|
const plugins = require("./mod01.plugins");
|
|
const mod00_check_1 = require("../mod00/mod00.check");
|
|
let genTypeDoc = function (configArg) {
|
|
let done = q.defer();
|
|
npmts_log_1.npmtsOra.text('now generating ' + 'TypeDoc documentation'.yellow);
|
|
plugins.beautylog.log('TypeDoc Output:');
|
|
let localSmartstream = new plugins.smartstream.Smartstream([
|
|
plugins.gulp.src(plugins.path.join(paths.tsDir, '**/*.ts')),
|
|
plugins.gulpTypedoc({
|
|
// TypeScript options (see typescript docs)
|
|
module: 'commonjs',
|
|
target: 'es6',
|
|
includeDeclarations: true,
|
|
// Output options (see typedoc docs)
|
|
out: paths.pagesApiDir,
|
|
json: plugins.path.join(paths.pagesApiDir, 'file.json'),
|
|
// TypeDoc options (see typedoc docs)
|
|
name: mod00_check_1.projectInfo.name,
|
|
readme: plugins.path.join(paths.cwd, 'README.md'),
|
|
// theme: "default",
|
|
version: true
|
|
})
|
|
]);
|
|
localSmartstream.run().then(() => {
|
|
plugins.beautylog.ok('TypeDoc documentation generated!');
|
|
done.resolve(configArg);
|
|
}, (err) => {
|
|
plugins.beautylog.warn('TypeDoc documentation generation failed!');
|
|
console.log(err);
|
|
done.resolve(configArg);
|
|
});
|
|
return done.promise;
|
|
};
|
|
exports.run = function (configArg) {
|
|
let done = q.defer();
|
|
if (configArg.docs) {
|
|
genTypeDoc(configArg)
|
|
.then(() => {
|
|
done.resolve(configArg);
|
|
});
|
|
}
|
|
else {
|
|
done.resolve(configArg);
|
|
}
|
|
;
|
|
return done.promise;
|
|
};
|