From 430f636ae4d14c51e28bb3815795722bf6da190a Mon Sep 17 00:00:00 2001 From: LosslessBot Date: Thu, 14 Jul 2016 13:02:58 +0200 Subject: [PATCH] now using EsDoc, closes #2 --- dist/npmts.jsdoc.js | 30 ++++++++++++++---------------- dist/npmts.plugins.d.ts | 3 ++- dist/npmts.plugins.js | 3 ++- package.json | 13 +++++++------ ts/npmts.jsdoc.ts | 30 ++++++++++++++---------------- ts/npmts.plugins.ts | 3 ++- 6 files changed, 41 insertions(+), 41 deletions(-) diff --git a/dist/npmts.jsdoc.js b/dist/npmts.jsdoc.js index 1e3278c..541d711 100644 --- a/dist/npmts.jsdoc.js +++ b/dist/npmts.jsdoc.js @@ -3,26 +3,24 @@ require("typings-global"); var plugins = require("./npmts.plugins"); var paths = require("./npmts.paths"); var npmts_promisechain_1 = require("./npmts.promisechain"); -var genJsdoc = function (configArg) { +var genEsDoc = function (configArg) { var done = plugins.Q.defer(); - npmts_promisechain_1.npmtsOra.text("now generating " + "JsDoc documentation".yellow); - plugins.gulp.src([ - plugins.path.join(paths.cwd, "README.md"), - plugins.path.join(paths.distDir, "**/*.js") - ]) - .pipe(plugins.g.jsdoc3({ - opts: { - destination: paths.docsDir - } - }, function () { - plugins.beautylog.ok("JsDoc documentation has been generated!"); - done.resolve(configArg); - })); + npmts_promisechain_1.npmtsOra.text("now generating " + "EsDoc documentation".yellow); + plugins.beautylog.log("ESDoc Output:"); + var esdocConfig = { + source: paths.distDir, + destination: paths.docsDir + }; + plugins.esdoc.generate(esdocConfig, plugins.esdocPublisher); + plugins.beautylog.ok("Docs by EsDoc have been created!"); + done.resolve(configArg); return done.promise; }; exports.run = function (configArg) { var done = plugins.Q.defer(); - genJsdoc(configArg) - .then(done.resolve); + genEsDoc(configArg) + .then(function () { + done.resolve(configArg); + }); return done.promise; }; diff --git a/dist/npmts.plugins.d.ts b/dist/npmts.plugins.d.ts index 19adfa9..30272c9 100644 --- a/dist/npmts.plugins.d.ts +++ b/dist/npmts.plugins.d.ts @@ -1,10 +1,11 @@ import "typings-global"; export import beautylog = require("beautylog"); +export declare let esdoc: any; +export declare let esdocPublisher: any; export declare let gulp: any; export declare let g: { gFunction: any; istanbul: any; - jsdoc3: any; mocha: any; replace: any; sourcemaps: any; diff --git a/dist/npmts.plugins.js b/dist/npmts.plugins.js index 158f0c1..be3e316 100644 --- a/dist/npmts.plugins.js +++ b/dist/npmts.plugins.js @@ -1,11 +1,12 @@ "use strict"; require("typings-global"); exports.beautylog = require("beautylog"); +exports.esdoc = require("esdoc"); +exports.esdocPublisher = require("esdoc/out/src/Publisher/publish"); exports.gulp = require("gulp"); exports.g = { gFunction: require("gulp-function"), istanbul: require("gulp-istanbul"), - jsdoc3: require("gulp-jsdoc3"), mocha: require("gulp-mocha"), replace: require("gulp-replace"), sourcemaps: require("gulp-sourcemaps") diff --git a/package.json b/package.json index dbac265..2aaf89b 100644 --- a/package.json +++ b/package.json @@ -29,11 +29,12 @@ }, "homepage": "https://gitlab.com/pushrocks/npmts#readme", "dependencies": { - "@types/minimatch": "^2.0.22-alpha", - "@types/q": "0.0.21-alpha", - "@types/shelljs": "^0.3.21-alpha", - "beautylog": "5.0.12", + "@types/minimatch": "^2.0.27-alpha", + "@types/q": "0.0.26-alpha", + "@types/shelljs": "^0.3.26-alpha", + "beautylog": "5.0.13", "early": "^2.0.13", + "esdoc": "^0.4.7", "gulp": "3.9.1", "gulp-concat": "^2.6.0", "gulp-function": "^1.3.6", @@ -54,9 +55,9 @@ "smartenv": "1.2.5", "smartfile": "4.0.10", "smartpath": "3.2.2", - "smartstring": "^2.0.10", + "smartstring": "^2.0.14", "source-map-support": "^0.4.1", - "tsn": "^1.0.5", + "tsn": "^1.0.6", "typescript": "^2.0.0-dev.20160630", "typings-global": "*" }, diff --git a/ts/npmts.jsdoc.ts b/ts/npmts.jsdoc.ts index 42717e7..2858974 100644 --- a/ts/npmts.jsdoc.ts +++ b/ts/npmts.jsdoc.ts @@ -3,28 +3,26 @@ import plugins = require("./npmts.plugins"); import paths = require("./npmts.paths"); import {npmtsOra} from "./npmts.promisechain"; -let genJsdoc = function(configArg){ +let genEsDoc = function(configArg){ let done = plugins.Q.defer(); - npmtsOra.text("now generating " + "JsDoc documentation".yellow); - plugins.gulp.src([ - plugins.path.join(paths.cwd,"README.md"), - plugins.path.join(paths.distDir,"**/*.js") - ]) - .pipe(plugins.g.jsdoc3({ - opts: { - destination: paths.docsDir - } - }, function(){ - plugins.beautylog.ok("JsDoc documentation has been generated!"); - done.resolve(configArg) - })); + npmtsOra.text("now generating " + "EsDoc documentation".yellow); + plugins.beautylog.log("ESDoc Output:"); + let esdocConfig = { + source: paths.distDir, + destination: paths.docsDir + }; + plugins.esdoc.generate(esdocConfig,plugins.esdocPublisher); + plugins.beautylog.ok("Docs by EsDoc have been created!"); + done.resolve(configArg); return done.promise; }; export let run = function(configArg){ let done = plugins.Q.defer(); - genJsdoc(configArg) - .then(done.resolve); + genEsDoc(configArg) + .then(() => { + done.resolve(configArg); + }); return done.promise; }; \ No newline at end of file diff --git a/ts/npmts.plugins.ts b/ts/npmts.plugins.ts index 0d9c9ab..f01363b 100644 --- a/ts/npmts.plugins.ts +++ b/ts/npmts.plugins.ts @@ -1,10 +1,11 @@ import "typings-global"; export import beautylog = require("beautylog"); +export let esdoc = require("esdoc"); +export let esdocPublisher = require("esdoc/out/src/Publisher/publish"); export let gulp = require("gulp"); export let g = { gFunction: require("gulp-function"), istanbul: require("gulp-istanbul"), - jsdoc3: require("gulp-jsdoc3"), mocha: require("gulp-mocha"), replace: require("gulp-replace"), sourcemaps: require("gulp-sourcemaps")