git.zone/tscoverage
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add --nodocs option

Browse Source
This commit is contained in:
Philipp Kunz 2016-08-13 23:54:17 +02:00
parent 2c254a2ecf
commit db1cfe4746
5 changed files with 51 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
dist/npmts.configfile.js vendored
View File

@ -8,12 +8,17 @@ exports.run = function (argvArg) {
npmts_promisechain_1.npmtsOra.text("looking for npmextra.json"); npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
var defaultConfig = { var defaultConfig = {
mode: "default", mode: "default",
notest: false notest: false,
nodocs: false
}; };
if (argvArg.notest) { if (argvArg.notest) {
defaultConfig.notest = true; defaultConfig.notest = true;
} }
; ;
if (argvArg.nodocs) {
defaultConfig.nodocs = true;
}
;
var config = plugins.npmextra.dataFor({ var config = plugins.npmextra.dataFor({
toolName: "npmts", toolName: "npmts",
defaultSettings: defaultConfig, defaultSettings: defaultConfig,

6
dist/npmts.typedoc.js vendored
View File

@ -27,9 +27,15 @@ var genTypeDoc = function (configArg) {
}; };
exports.run = function (configArg) { exports.run = function (configArg) {
var done = plugins.Q.defer(); var done = plugins.Q.defer();
if (configArg.nodocs) {
done.resolve(configArg);
}
else {
genTypeDoc(configArg) genTypeDoc(configArg)
.then(function () { .then(function () {
done.resolve(configArg); done.resolve(configArg);
}); });
}
;
return done.promise; return done.promise;
}; };

5
package.json
View File

@ -7,12 +7,13 @@
"npmts": "dist/cli.js" "npmts": "dist/cli.js"
}, },
"scripts": { "scripts": {
"test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest)", "test": "(npm run compile && npm run setupCheck && npm run check && npm run checkVersion && npm run checkNoTest && npm run checkNoDocs)",
"compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )", "compile": "(rm -rf test/ && rm -r dist/ && mkdir dist/ && tsc && cp assets/cli.js dist/ )",
"setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)", "setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
"check": "(cd test && npm install && node ../dist/index.js)", "check": "(cd test && npm install && node ../dist/index.js)",
"checkVersion": "(cd test/ && node ../dist/index.js -v)", "checkVersion": "(cd test/ && node ../dist/index.js -v)",
"checkNoTest": "(cd test && node ../dist/index.js --notest)" "checkNoTest": "(cd test && node ../dist/index.js --notest)",
"checkNoDocs": "(cd test && node ../dist/index.js --nodocs)"
}, },
"repository": { "repository": {
"type": "git", "type": "git",

6
ts/npmts.configfile.ts
View File

@ -7,11 +7,15 @@ export var run = function(argvArg){
npmtsOra.text("looking for npmextra.json"); npmtsOra.text("looking for npmextra.json");
let defaultConfig = { let defaultConfig = {
mode: "default", mode: "default",
notest:false notest:false,
nodocs:false
}; };
if(argvArg.notest){ if(argvArg.notest){
defaultConfig.notest = true; defaultConfig.notest = true;
}; };
if(argvArg.nodocs){
defaultConfig.nodocs = true;
};
let config = plugins.npmextra.dataFor({ let config = plugins.npmextra.dataFor({
toolName:"npmts", toolName:"npmts",
defaultSettings:defaultConfig, defaultSettings:defaultConfig,

16
ts/npmts.typedoc.ts
View File

@ -1,13 +1,13 @@
import "typings-global"; import "typings-global";
import plugins = require("./npmts.plugins"); import plugins = require("./npmts.plugins");
import paths = require("./npmts.paths"); import paths = require("./npmts.paths");
import {npmtsOra} from "./npmts.promisechain"; import { npmtsOra } from "./npmts.promisechain";
let genTypeDoc = function(configArg){ let genTypeDoc = function (configArg) {
let done = plugins.Q.defer(); let done = plugins.Q.defer();
npmtsOra.text("now generating " + "TypeDoc documentation".yellow); npmtsOra.text("now generating " + "TypeDoc documentation".yellow);
plugins.beautylog.log("TypeDoc Output:"); plugins.beautylog.log("TypeDoc Output:");
plugins.gulp.src(plugins.path.join(paths.tsDir,"**/*.ts")) plugins.gulp.src(plugins.path.join(paths.tsDir, "**/*.ts"))
.pipe(plugins.g.typedoc({ .pipe(plugins.g.typedoc({
// TypeScript options (see typescript docs) // TypeScript options (see typescript docs)
module: "commonjs", module: "commonjs",
@ -16,7 +16,7 @@ let genTypeDoc = function(configArg){
// Output options (see typedoc docs) // Output options (see typedoc docs)
out: paths.docsDir, out: paths.docsDir,
json: plugins.path.join(paths.docsDir,"file.json"), json: plugins.path.join(paths.docsDir, "file.json"),
// TypeDoc options (see typedoc docs) // TypeDoc options (see typedoc docs)
name: "my-project", name: "my-project",
@ -25,16 +25,20 @@ let genTypeDoc = function(configArg){
ignoreCompilerErrors: true, ignoreCompilerErrors: true,
version: true, version: true,
})) }))
.pipe(plugins.g.gFunction(done.resolve,"atEnd")); .pipe(plugins.g.gFunction(done.resolve, "atEnd"));
return done.promise; return done.promise;
}; };
export let run = function(configArg){ export let run = function (configArg) {
let done = plugins.Q.defer(); let done = plugins.Q.defer();
if (configArg.nodocs) {
done.resolve(configArg);
} else {
genTypeDoc(configArg) genTypeDoc(configArg)
.then(() => { .then(() => {
done.resolve(configArg); done.resolve(configArg);
}); });
};
return done.promise; return done.promise;
}; };