diff --git a/dist/npmts.jsdoc.js b/dist/npmts.jsdoc.js deleted file mode 100644 index 541d711..0000000 --- a/dist/npmts.jsdoc.js +++ /dev/null @@ -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; -}; diff --git a/dist/npmts.plugins.d.ts b/dist/npmts.plugins.d.ts index 30272c9..2ef5988 100644 --- a/dist/npmts.plugins.d.ts +++ b/dist/npmts.plugins.d.ts @@ -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; diff --git a/dist/npmts.plugins.js b/dist/npmts.plugins.js index be3e316..7f73b5d 100644 --- a/dist/npmts.plugins.js +++ b/dist/npmts.plugins.js @@ -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"); diff --git a/dist/npmts.promisechain.js b/dist/npmts.promisechain.js index c26f714..0b713a2 100644 --- a/dist/npmts.promisechain.js +++ b/dist/npmts.promisechain.js @@ -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 = "" + diff --git a/dist/npmts.jsdoc.d.ts b/dist/npmts.typedoc.d.ts similarity index 100% rename from dist/npmts.jsdoc.d.ts rename to dist/npmts.typedoc.d.ts diff --git a/dist/npmts.typedoc.js b/dist/npmts.typedoc.js new file mode 100644 index 0000000..e824892 --- /dev/null +++ b/dist/npmts.typedoc.js @@ -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; +}; diff --git a/package.json b/package.json index bdfa24d..4e5bb2e 100644 --- a/package.json +++ b/package.json @@ -29,10 +29,10 @@ }, "homepage": "https://gitlab.com/pushrocks/npmts#readme", "dependencies": { - "@types/minimatch": "^2.0.27-alpha", - "@types/q": "0.0.26-alpha", - "@types/shelljs": "^0.3.26-alpha", - "beautylog": "5.0.13", + "@types/minimatch": "*", + "@types/q": "*", + "@types/shelljs": "*", + "beautylog": "5.0.14", "early": "^2.0.13", "esdoc": "^0.4.7", "gulp": "3.9.1", @@ -44,6 +44,7 @@ "gulp-mocha": "^2.2.0", "gulp-replace": "^0.5.4", "gulp-sourcemaps": "^1.6.0", + "gulp-typedoc": "^2.0.0", "lodash": "^4.13.1", "merge2": "1.0.2", "projectinfo": "1.0.3", @@ -56,8 +57,9 @@ "smartfile": "4.0.10", "smartpath": "3.2.2", "smartstring": "^2.0.14", - "source-map-support": "^0.4.1", + "source-map-support": "^0.4.2", "tsn": "^1.0.6", + "typedoc": "^0.4.4", "typescript": "^2.0.0-dev.20160630", "typings-global": "*" }, diff --git a/ts/npmts.esdoc.ts b/ts/npmts.esdoc.ts deleted file mode 100644 index 2858974..0000000 --- a/ts/npmts.esdoc.ts +++ /dev/null @@ -1,28 +0,0 @@ -import "typings-global"; -import plugins = require("./npmts.plugins"); -import paths = require("./npmts.paths"); -import {npmtsOra} from "./npmts.promisechain"; - -let genEsDoc = function(configArg){ - let done = plugins.Q.defer(); - 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(); - 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 f01363b..011375e 100644 --- a/ts/npmts.plugins.ts +++ b/ts/npmts.plugins.ts @@ -1,14 +1,13 @@ 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"), mocha: require("gulp-mocha"), replace: require("gulp-replace"), - sourcemaps: require("gulp-sourcemaps") + sourcemaps: require("gulp-sourcemaps"), + typedoc: require("gulp-typedoc") }; export let lodashObject = require('lodash/fp/object'); export let merge2 = require("merge2"); diff --git a/ts/npmts.promisechain.ts b/ts/npmts.promisechain.ts index 9092b3b..7023e0c 100644 --- a/ts/npmts.promisechain.ts +++ b/ts/npmts.promisechain.ts @@ -8,7 +8,7 @@ import NpmtsAssets = require("./npmts.assets"); import NpmtsClean = require("./npmts.clean"); import NpmtsCompile = require("./npmts.compile"); import NpmtsConfigFile = require("./npmts.configfile"); -import NpmtsEsDoc = require("./npmts.esdoc"); +import NpmtsTypeDoc = require("./npmts.typedoc"); import NpmtsOptions = require("./npmts.options"); import NpmtsTests = require("./npmts.tests"); @@ -20,7 +20,7 @@ export let promisechain = function(argvArg){ .then(NpmtsClean.run) .then(NpmtsCompile.run) .then(NpmtsAssets.run) - .then(NpmtsEsDoc.run) + .then(NpmtsTypeDoc.run) .then(NpmtsTests.run) .then(function(configArg){ let shipString = "" + diff --git a/ts/npmts.typedoc.ts b/ts/npmts.typedoc.ts new file mode 100644 index 0000000..291c730 --- /dev/null +++ b/ts/npmts.typedoc.ts @@ -0,0 +1,40 @@ +import "typings-global"; +import plugins = require("./npmts.plugins"); +import paths = require("./npmts.paths"); +import {npmtsOra} from "./npmts.promisechain"; + +let genTypeDoc = function(configArg){ + let done = plugins.Q.defer(); + 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; +}; + + +export let run = function(configArg){ + let done = plugins.Q.defer(); + genTypeDoc(configArg) + .then(() => { + done.resolve(configArg); + }); + return done.promise; +}; \ No newline at end of file