now using typedoc
This commit is contained in:
		
							
								
								
									
										26
									
								
								dist/npmts.jsdoc.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										26
									
								
								dist/npmts.jsdoc.js
									
									
									
									
										vendored
									
									
								
							@@ -1,26 +0,0 @@
 | 
			
		||||
"use strict";
 | 
			
		||||
require("typings-global");
 | 
			
		||||
var plugins = require("./npmts.plugins");
 | 
			
		||||
var paths = require("./npmts.paths");
 | 
			
		||||
var npmts_promisechain_1 = require("./npmts.promisechain");
 | 
			
		||||
var genEsDoc = function (configArg) {
 | 
			
		||||
    var done = plugins.Q.defer();
 | 
			
		||||
    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();
 | 
			
		||||
    genEsDoc(configArg)
 | 
			
		||||
        .then(function () {
 | 
			
		||||
        done.resolve(configArg);
 | 
			
		||||
    });
 | 
			
		||||
    return done.promise;
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										3
									
								
								dist/npmts.plugins.d.ts
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								dist/npmts.plugins.d.ts
									
									
									
									
										vendored
									
									
								
							@@ -1,7 +1,5 @@
 | 
			
		||||
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;
 | 
			
		||||
@@ -9,6 +7,7 @@ export declare let g: {
 | 
			
		||||
    mocha: any;
 | 
			
		||||
    replace: any;
 | 
			
		||||
    sourcemaps: any;
 | 
			
		||||
    typedoc: any;
 | 
			
		||||
};
 | 
			
		||||
export declare let lodashObject: any;
 | 
			
		||||
export declare let merge2: any;
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										5
									
								
								dist/npmts.plugins.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								dist/npmts.plugins.js
									
									
									
									
										vendored
									
									
								
							@@ -1,15 +1,14 @@
 | 
			
		||||
"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"),
 | 
			
		||||
    mocha: require("gulp-mocha"),
 | 
			
		||||
    replace: require("gulp-replace"),
 | 
			
		||||
    sourcemaps: require("gulp-sourcemaps")
 | 
			
		||||
    sourcemaps: require("gulp-sourcemaps"),
 | 
			
		||||
    typedoc: require("gulp-typedoc")
 | 
			
		||||
};
 | 
			
		||||
exports.lodashObject = require('lodash/fp/object');
 | 
			
		||||
exports.merge2 = require("merge2");
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								dist/npmts.promisechain.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								dist/npmts.promisechain.js
									
									
									
									
										vendored
									
									
								
							@@ -6,7 +6,7 @@ var NpmtsAssets = require("./npmts.assets");
 | 
			
		||||
var NpmtsClean = require("./npmts.clean");
 | 
			
		||||
var NpmtsCompile = require("./npmts.compile");
 | 
			
		||||
var NpmtsConfigFile = require("./npmts.configfile");
 | 
			
		||||
var NpmtsJsdoc = require("./npmts.jsdoc");
 | 
			
		||||
var NpmtsTypeDoc = require("./npmts.typedoc");
 | 
			
		||||
var NpmtsOptions = require("./npmts.options");
 | 
			
		||||
var NpmtsTests = require("./npmts.tests");
 | 
			
		||||
exports.promisechain = function (argvArg) {
 | 
			
		||||
@@ -17,7 +17,7 @@ exports.promisechain = function (argvArg) {
 | 
			
		||||
        .then(NpmtsClean.run)
 | 
			
		||||
        .then(NpmtsCompile.run)
 | 
			
		||||
        .then(NpmtsAssets.run)
 | 
			
		||||
        .then(NpmtsJsdoc.run)
 | 
			
		||||
        .then(NpmtsTypeDoc.run)
 | 
			
		||||
        .then(NpmtsTests.run)
 | 
			
		||||
        .then(function (configArg) {
 | 
			
		||||
        var shipString = "" +
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										35
									
								
								dist/npmts.typedoc.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										35
									
								
								dist/npmts.typedoc.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,35 @@
 | 
			
		||||
"use strict";
 | 
			
		||||
require("typings-global");
 | 
			
		||||
var plugins = require("./npmts.plugins");
 | 
			
		||||
var paths = require("./npmts.paths");
 | 
			
		||||
var npmts_promisechain_1 = require("./npmts.promisechain");
 | 
			
		||||
var genTypeDoc = function (configArg) {
 | 
			
		||||
    var done = plugins.Q.defer();
 | 
			
		||||
    npmts_promisechain_1.npmtsOra.text("now generating " + "EsDoc documentation".yellow);
 | 
			
		||||
    plugins.beautylog.log("TypeDoc Output:");
 | 
			
		||||
    plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts"))
 | 
			
		||||
        .pipe(plugins.g.typedoc({
 | 
			
		||||
        // TypeScript options (see typescript docs) 
 | 
			
		||||
        module: "commonjs",
 | 
			
		||||
        target: "es6",
 | 
			
		||||
        includeDeclarations: true,
 | 
			
		||||
        // Output options (see typedoc docs) 
 | 
			
		||||
        out: paths.docsDir,
 | 
			
		||||
        json: plugins.path.join(paths.docsDir, "file.json"),
 | 
			
		||||
        // TypeDoc options (see typedoc docs) 
 | 
			
		||||
        name: "my-project",
 | 
			
		||||
        //theme: "default",
 | 
			
		||||
        ignoreCompilerErrors: false,
 | 
			
		||||
        version: true,
 | 
			
		||||
    }))
 | 
			
		||||
        .pipe(plugins.g.gFunction(done.resolve, "atEnd"));
 | 
			
		||||
    return done.promise;
 | 
			
		||||
};
 | 
			
		||||
exports.run = function (configArg) {
 | 
			
		||||
    var done = plugins.Q.defer();
 | 
			
		||||
    genTypeDoc(configArg)
 | 
			
		||||
        .then(function () {
 | 
			
		||||
        done.resolve(configArg);
 | 
			
		||||
    });
 | 
			
		||||
    return done.promise;
 | 
			
		||||
};
 | 
			
		||||
		Reference in New Issue
	
	Block a user