5.4.19

.gitignore

@@ -1,4 +1,4 @@
 node_modules/
 test/
-docs/
+pages/
 .DS_Store

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-image: hosttoday/ht-docker-node:npmts
+image: hosttoday/ht-docker-node:npmci
 
 stages:
 - test
 - release
 - trigger
-- page
+- pages
 
 testLEGACY:
   stage: test
@@ -45,3 +45,15 @@ trigger:
     - tags
   tags:
     - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: pages
+  script:
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

README.md

@@ -1,12 +1,20 @@
 # npmts
 Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
 
-## Status
+## Availabililty
+[![npm](https://img.shields.io/badge/npm-npmjs.com-blue.svg)](https://www.npmjs.com/package/npmts)
+[![git](https://img.shields.io/badge/git-gitlab.com-blue.svg)](https://gitlab.com/pushrocks/npmts)
+[![git](https://img.shields.io/badge/git%20mirror-github.com-blue.svg)](https://github.com/pushrocks/npmts)
+[![docs](https://img.shields.io/badge/docs-gitlab.io-blue.svg)](https://pushrocks.gitlab.io/npmts/docs)
+
+## Status for master
 [![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/npmts/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
 [![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
 [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
 [![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
-[![codecov.io](https://codecov.io/github/pushrocks/npmts/coverage.svg?branch=master)](https://codecov.io/github/pushrocks/npmts?branch=master)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 
 ## What is NPMTS?
 NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
@@ -38,17 +46,33 @@ Then add it to your package.json's script section to trigger a build:
 
 1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
 1. **Clean:** Clean up from any previous builds (old js files)
-1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
+1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
+1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
 1. **Documentation:** Create TypeDoc Documentation from TypeScript files
 1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
 
 ### npmextra.json
-the npmts section in npmtsextra.json can be used to configure npmts.
+the npmts section in npmextra.json can be used to configure npmts.
+
+**Default**
+>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
+with default behaviour.
 
 ```json
 {
   "npmts":{
-    "mode":"default",
+    "mode":"default"
+  }
+}
+```
+
+**Custom settings**
+```json
+{
+  "mode":"custom",
+  "docs":false,
+  "test":true,
+  "npmts":{
     "ts":{
       "./customdir/*.ts":"./"
     },
@@ -63,7 +87,10 @@ the npmts section in npmtsextra.json can be used to configure npmts.
 
 | key | default value | description |
 | --- | --- | --- |
-| `"mode"` | `"default"` | "default" will do some default stuff, "custom" only does what you specify |
+| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
+| `"docs"` | `true` | create docs for your module |
+| `"test"` | `true` | test your module |
+| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
 | `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
 | `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
 
@@ -74,7 +101,7 @@ by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
 Use commonjs module system for wiring up files.
 
 ### Declaration files
-**npmts** also creates an `./dist/index.d.ts` declaration file by default.
+**npmts** also creates declaration files like `./dist/index.d.ts` by default.
 You can reference it in your package.json like this.
 
 ```json
@@ -86,9 +113,14 @@ This is in line with the latest TypeScript best practices.
 You can then import plugins via the TypeScript `import` Syntax
 and tsc will pick up the declaration file automatically.
 
+### TypeDoc
+By default TypeDoc will create docs for your module in `./pages/api/` directory.
+> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
+It also allows you to integrate api docs with a gitbook located in `./docs/` 
+
 ## Some notes:
 #### Typings for third party modules that do not bundle declaration files
-NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
+NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
 
 #### Instrumentalize Code
 npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
@@ -109,6 +141,11 @@ thanks to autogenerated source maps.
 * Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
 * Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
 
+## Future Scope:
+* automatically manage badges in README
+* manage tslint to enforce code best practices
+* tear down any differences between local and CI environments by using brand new npmdocker
+
 ## About the authors:
 [![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
 

dist/npmts.check.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="q" />
+import * as plugins from "./npmts.plugins";
+export declare let run: (configArg: any) => plugins.Q.Promise<{}>;

dist/npmts.check.js

@@ -0,0 +1,128 @@
+"use strict";
+var plugins = require("./npmts.plugins");
+var paths = require("./npmts.paths");
+var npmts_promisechain_1 = require("./npmts.promisechain");
+var checkProjectTypings = function (configArg) {
+    var done = plugins.Q.defer();
+    var cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
+    if (typeof cwdProjectInfo.packageJson.typings == "undefined") {
+        plugins.beautylog.error("please add typings field to package.json");
+        process.exit(1);
+    }
+    ;
+    done.resolve(configArg);
+    return done.promise;
+};
+var depcheckOptions = {
+    ignoreBinPackage: false,
+    parsers: {
+        '*.ts': plugins.depcheck.parser.typescript,
+    },
+    detectors: [
+        plugins.depcheck.detector.requireCallExpression,
+        plugins.depcheck.detector.importDeclaration
+    ],
+    specials: [
+        plugins.depcheck.special.eslint,
+        plugins.depcheck.special.webpack
+    ],
+};
+var checkDependencies = function (configArg) {
+    var done = plugins.Q.defer();
+    var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
+        ignoreDirs: [
+            'test',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [
+            "@types/*",
+            "babel-preset-*"
+        ]
+    });
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
+        for (var _i = 0, _a = unused.dependencies; _i < _a.length; _i++) {
+            var item = _a[_i];
+            plugins.beautylog.warn("Watch out: unused dependency " + item.red);
+        }
+        ;
+        for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
+            var item = _c[_b];
+            plugins.beautylog.error("unused devDependency " + item.red);
+        }
+        ;
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info("exiting due to missing dependencies in package.json");
+            process.exit(1);
+        }
+        for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
+            var item = _e[_d];
+            plugins.beautylog.warn("Watch out: could not parse file " + item.red);
+        }
+        ;
+        for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
+            var item = _g[_f];
+            plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
+        }
+        ;
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+var checkDevDependencies = function (configArg) {
+    var done = plugins.Q.defer();
+    var depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
+        ignoreDirs: [
+            'ts',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [
+            "@types/*",
+            "babel-preset-*"
+        ]
+    });
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, function (unused) {
+        for (var _i = 0, _a = unused.devDependencies; _i < _a.length; _i++) {
+            var item = _a[_i];
+            plugins.beautylog.log("unused devDependency " + item.red);
+        }
+        ;
+        for (var _b = 0, _c = unused.missing; _b < _c.length; _b++) {
+            var item = _c[_b];
+            plugins.beautylog.error("unused devDependency " + item.red);
+        }
+        ;
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info("exiting due to missing dependencies in package.json");
+            process.exit(1);
+        }
+        for (var _d = 0, _e = unused.invalidFiles; _d < _e.length; _d++) {
+            var item = _e[_d];
+            plugins.beautylog.warn("Watch out: could not parse file " + item.red);
+        }
+        ;
+        for (var _f = 0, _g = unused.invalidDirs; _f < _g.length; _f++) {
+            var item = _g[_f];
+            plugins.beautylog.warn("Watch out: could not parse directory " + item.red);
+        }
+        ;
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+var checkNodeVersion = function (configArg) {
+    var done = plugins.Q.defer();
+    done.resolve(configArg);
+    return done.promise;
+};
+exports.run = function (configArg) {
+    var done = plugins.Q.defer();
+    npmts_promisechain_1.npmtsOra.text("running project checks..."),
+        checkProjectTypings(configArg)
+            .then(checkDependencies)
+            .then(checkDevDependencies)
+            .then(checkNodeVersion)
+            .then(done.resolve);
+    return done.promise;
+};

dist/npmts.clean.js

@@ -4,24 +4,18 @@ var plugins = require("./npmts.plugins");
 var paths = require("./npmts.paths");
 var npmts_promisechain_1 = require("./npmts.promisechain");
 var removeDist = function () {
-    npmts_promisechain_1.npmtsOra.text("cleaning " + "dist".yellow + " folder");
+    npmts_promisechain_1.npmtsOra.text("cleaning dist folder");
     return plugins.smartfile.fs.remove(paths.distDir);
 };
-var removeTypings = function () {
-    var done = plugins.Q.defer();
-    npmts_promisechain_1.npmtsOra.text("cleaning " + "typings".yellow + " folder");
-    if (false) {
-    }
-    else {
-        done.resolve();
-    }
-    return done.promise;
+var removePages = function () {
+    npmts_promisechain_1.npmtsOra.text("cleaning pages folder");
+    return plugins.smartfile.fs.remove(paths.pagesDir);
 };
 exports.run = function (configArg) {
     npmts_promisechain_1.npmtsOra.text("cleaning up from previous builds...");
     var done = plugins.Q.defer();
     removeDist()
-        .then(removeTypings)
+        .then(removePages)
         .then(function () {
         plugins.beautylog.ok("Cleaned up from previous builds!");
         done.resolve(configArg);

dist/npmts.configfile.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="q" />
-import "typings-global";
-import plugins = require("./npmts.plugins");
-export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;

dist/npmts.configfile.js

@@ -1,35 +0,0 @@
-"use strict";
-require("typings-global");
-var plugins = require("./npmts.plugins");
-var paths = require("./npmts.paths");
-var npmts_promisechain_1 = require("./npmts.promisechain");
-exports.run = function (argvArg) {
-    var done = plugins.Q.defer();
-    npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
-    var defaultConfig = {
-        mode: "default",
-        notest: false
-    };
-    if (argvArg.notest) {
-        defaultConfig.notest = true;
-    }
-    ;
-    var config = plugins.npmextra.dataFor({
-        toolName: "npmts",
-        defaultSettings: defaultConfig,
-        cwd: paths.cwd
-    });
-    switch (config.mode) {
-        case "default":
-        case "custom":
-            plugins.beautylog.ok("mode is " + config.mode.yellow);
-            done.resolve(config);
-            break;
-        default:
-            plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
-            process.exit(1);
-    }
-    ;
-    done.resolve(config);
-    return done.promise;
-};

dist/npmts.options.d.ts

@@ -1,5 +1,15 @@
 /// <reference types="q" />
 import "typings-global";
 import plugins = require("./npmts.plugins");
-export declare let isCi: () => any;
-export declare var run: (configArg: any) => plugins.Q.Promise<{}>;
+export declare type npmtsMode = "default" | "custom";
+export interface npmtsConfig {
+    argv: any;
+    coverageTreshold: number;
+    docs: boolean;
+    mode: npmtsMode;
+    test: boolean;
+    testTs: any;
+    ts: any;
+    tsOptions: any;
+}
+export declare var run: (argvArg: any) => plugins.Q.Promise<{}>;

dist/npmts.options.js

@@ -1,19 +1,44 @@
 "use strict";
 require("typings-global");
 var plugins = require("./npmts.plugins");
+var paths = require("./npmts.paths");
 var npmts_promisechain_1 = require("./npmts.promisechain");
-exports.isCi = function () {
-    return plugins.smartci.check.isCi();
-};
-exports.run = function (configArg) {
+;
+exports.run = function (argvArg) {
     var done = plugins.Q.defer();
-    var config = configArg;
-    npmts_promisechain_1.npmtsOra.text("now determining build options...");
+    var defaultConfig = {
+        argv: undefined,
+        coverageTreshold: 70,
+        docs: true,
+        mode: "default",
+        test: true,
+        testTs: {},
+        ts: {},
+        tsOptions: {}
+    };
+    // mix with configfile
+    npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
+    var config = plugins.npmextra.dataFor({
+        toolName: "npmts",
+        defaultSettings: defaultConfig,
+        cwd: paths.cwd
+    });
+    // add argv
+    config.argv = argvArg;
+    // check mode
+    switch (config.mode) {
+        case "default":
+        case "custom":
+            plugins.beautylog.ok("mode is " + config.mode);
+            done.resolve(config);
+            break;
+        default:
+            plugins.beautylog.error("mode not recognised!");
+            process.exit(1);
+    }
+    ;
     //handle default mode
     if (config.mode == "default") {
-        config.typings = [
-            "./ts/typings.json"
-        ];
         config.ts = (_a = {},
             _a["./ts/**/*.ts"] = "./dist/",
             _a
@@ -22,13 +47,17 @@ exports.run = function (configArg) {
             _b["./test/test.ts"] = "./test/",
             _b
         );
-        config.test = ["./index.js"];
     }
-    //check if config.tsOptions is available
-    config.tsOptions ? void (0) : config.tsOptions = {};
-    config.coverageTreshold ? void (0) : config.coverageTreshold = 70;
-    // handle docs
-    config.docs ? void (0) : config.docs = {};
+    ;
+    // mix with commandline
+    if (config.argv.notest) {
+        config.test = false;
+    }
+    ;
+    if (config.argv.nodocs) {
+        config.docs = false;
+    }
+    ;
     plugins.beautylog.ok("build options are ready!");
     done.resolve(config);
     return done.promise;

dist/npmts.paths.d.ts

@@ -3,10 +3,11 @@ export declare let npmtsPackageRoot: string;
 export declare let cwd: string;
 export declare let tsDir: string;
 export declare let distDir: string;
-export declare let docsDir: string;
 export declare let testDir: string;
 export declare let typingsDir: string;
 export declare let coverageDir: string;
+export declare let pagesDir: string;
+export declare let pagesApiDir: string;
 export declare let npmtsAssetsDir: string;
 export declare let indexTS: string;
 export declare let testTS: string;

dist/npmts.paths.js

@@ -1,17 +1,19 @@
 "use strict";
 require("typings-global");
 var plugins = require("./npmts.plugins");
-//Npmts Paths
+// NPMTS Paths
 exports.npmtsPackageRoot = plugins.path.join(__dirname, "../");
-//Project paths
+// Project paths
 exports.cwd = process.cwd();
-//Directories
+// Directories
 exports.tsDir = plugins.path.join(exports.cwd, "ts/");
 exports.distDir = plugins.path.join(exports.cwd, "dist/");
-exports.docsDir = plugins.path.join(exports.cwd, "docs/");
 exports.testDir = plugins.path.join(exports.cwd, "test/");
 exports.typingsDir = plugins.path.join(exports.cwd, "ts/typings/");
 exports.coverageDir = plugins.path.join(exports.cwd, "coverage/");
+// Pages
+exports.pagesDir = plugins.path.join(exports.cwd, "pages/");
+exports.pagesApiDir = plugins.path.join(exports.pagesDir, "/api");
 exports.npmtsAssetsDir = plugins.path.join(__dirname, "../assets/");
 //Files
 exports.indexTS = plugins.path.join(exports.cwd, "ts/index.ts");

dist/npmts.plugins.d.ts

@@ -1,13 +1,13 @@
 import "typings-global";
 export import beautylog = require("beautylog");
-export declare let gulp: any;
+export declare let depcheck: any;
+export import gulp = require("gulp");
 export declare let g: {
     babel: any;
     istanbul: any;
     gFunction: any;
     injectModules: any;
     mocha: any;
-    replace: any;
     sourcemaps: any;
     typedoc: any;
 };
@@ -17,7 +17,6 @@ export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");
 export import shelljs = require("shelljs");
-export declare let smartci: any;
 export import smartcli = require("smartcli");
 export import smartcov = require("smartcov");
 export import smartenv = require("smartenv");

dist/npmts.plugins.js

@@ -1,6 +1,7 @@
 "use strict";
 require("typings-global");
 exports.beautylog = require("beautylog");
+exports.depcheck = require("depcheck");
 exports.gulp = require("gulp");
 exports.g = {
     babel: require("gulp-babel"),
@@ -8,7 +9,6 @@ exports.g = {
     gFunction: require("gulp-function"),
     injectModules: require("gulp-inject-modules"),
     mocha: require("gulp-mocha"),
-    replace: require("gulp-replace"),
     sourcemaps: require("gulp-sourcemaps"),
     typedoc: require("gulp-typedoc")
 };
@@ -18,7 +18,6 @@ exports.projectinfo = require("projectinfo");
 exports.path = require("path");
 exports.Q = require("q");
 exports.shelljs = require("shelljs");
-exports.smartci = require("smartci");
 exports.smartcli = require("smartcli");
 exports.smartcov = require("smartcov");
 exports.smartenv = require("smartenv");

dist/npmts.promisechain.js

@@ -3,18 +3,18 @@ require("typings-global");
 var plugins = require("./npmts.plugins");
 exports.npmtsOra = new plugins.beautylog.Ora("setting up TaskChain", "cyan");
 var NpmtsAssets = require("./npmts.assets");
+var NpmtsCheck = require("./npmts.check");
 var NpmtsClean = require("./npmts.clean");
 var NpmtsCompile = require("./npmts.compile");
-var NpmtsConfigFile = require("./npmts.configfile");
 var NpmtsTypeDoc = require("./npmts.typedoc");
 var NpmtsOptions = require("./npmts.options");
 var NpmtsTests = require("./npmts.tests");
 exports.promisechain = function (argvArg) {
     var done = plugins.Q.defer();
     exports.npmtsOra.start();
-    NpmtsConfigFile.run(argvArg)
-        .then(NpmtsOptions.run)
+    NpmtsOptions.run(argvArg)
         .then(NpmtsClean.run)
+        .then(NpmtsCheck.run)
         .then(NpmtsCompile.run)
         .then(NpmtsAssets.run)
         .then(NpmtsTypeDoc.run)

dist/npmts.tests.js

@@ -25,7 +25,7 @@ var mocha = function (configArg) {
         plugins.gulp.src([plugins.path.join(paths.cwd, "test/test.js")])
             .pipe(plugins.g.babel({
             presets: [
-                plugins.path.join(paths.npmtsPackageRoot, "node_modules/babel-preset-es2015/index.js")
+                require.resolve("babel-preset-es2015")
             ]
         }))
             .pipe(plugins.g.injectModules())
@@ -60,7 +60,7 @@ var coverage = function (configArg) {
 exports.run = function (configArg) {
     var done = plugins.Q.defer();
     var config = configArg;
-    if (config.notest != true) {
+    if (config.test === true) {
         npmts_promisechain_1.npmtsOra.text("now starting tests");
         plugins.beautylog.log("-------------------------------------------------------\n" +
             "*************************** TESTS: ***************************\n" +

dist/npmts.typedoc.js

@@ -14,8 +14,8 @@ var genTypeDoc = function (configArg) {
         target: "es6",
         includeDeclarations: true,
         // Output options (see typedoc docs) 
-        out: paths.docsDir,
-        json: plugins.path.join(paths.docsDir, "file.json"),
+        out: paths.pagesApiDir,
+        json: plugins.path.join(paths.pagesApiDir, "file.json"),
         // TypeDoc options (see typedoc docs) 
         name: "my-project",
         //theme: "default",
@@ -27,9 +27,15 @@ var genTypeDoc = function (configArg) {
 };
 exports.run = function (configArg) {
     var done = plugins.Q.defer();
-    genTypeDoc(configArg)
-        .then(function () {
+    if (configArg.docs) {
+        genTypeDoc(configArg)
+            .then(function () {
+            done.resolve(configArg);
+        });
+    }
+    else {
         done.resolve(configArg);
-    });
+    }
+    ;
     return done.promise;
 };

docs/book.json

@@ -0,0 +1,15 @@
+{
+    "structure": {
+        "readme": "index.md"
+    },
+    "plugins": [
+        "tonic",
+        "edit-link"
+    ],
+    "pluginsConfig": {
+        "edit-link": {
+            "base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
+            "label": "Edit on GitLab"
+        }
+    }
+}

docs/index.md

@@ -0,0 +1,152 @@
+# npmts
+Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
+
+## Availabililty
+[![npm](https://img.shields.io/badge/npm-npmjs.com-blue.svg)](https://www.npmjs.com/package/npmts)
+[![git](https://img.shields.io/badge/git-gitlab.com-blue.svg)](https://gitlab.com/pushrocks/npmts)
+[![git](https://img.shields.io/badge/git%20mirror-github.com-blue.svg)](https://github.com/pushrocks/npmts)
+[![docs](https://img.shields.io/badge/docs-gitlab.io-blue.svg)](https://pushrocks.gitlab.io/npmts/docs)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/npmts/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+
+## What is NPMTS?
+NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
+By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works.
+
+There is a docker image available that includes npmts to make CI a breeze:  
+[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
+
+### Install
+First install npmts globally, then install the npmts-g locally.
+
+> **npmts-g* checks if the global version of npmts suffices the modules requirements.
+If not it installs npmts locally in the right version during npm install. 
+
+```sh
+npm install npmts -g # installs npmts globally
+npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
+```
+
+Then add it to your package.json's script section to trigger a build:
+
+```json
+"scripts": {
+    "test": "(npmts)"
+}
+```
+
+### Default task execution order
+
+1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
+1. **Clean:** Clean up from any previous builds (old js files)
+1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
+1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
+1. **Documentation:** Create TypeDoc Documentation from TypeScript files
+1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
+
+### npmextra.json
+the npmts section in npmextra.json can be used to configure npmts.
+
+**Default**
+>Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
+with default behaviour.
+
+```json
+{
+  "npmts":{
+    "mode":"default"
+  }
+}
+```
+
+**Custom settings**
+```json
+{
+  "mode":"custom",
+  "docs":false,
+  "test":true,
+  "npmts":{
+    "ts":{
+      "./customdir/*.ts":"./"
+    },
+    "tsOptions":{
+      "declaration":false,
+      "target":"ES6"
+    },
+    "cli":true
+  }
+}
+```
+
+| key | default value | description |
+| --- | --- | --- |
+| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
+| `"docs"` | `true` | create docs for your module |
+| `"test"` | `true` | test your module |
+| `"ts"` | `{"./ts/*.ts":"./","./test/test.ts":"./test/"}` | allows you to define multiple ts portions |
+| `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
+| `"cli"` | "false" | some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use. |
+
+### TypeScript
+by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
+`./dist/*.js` and `./test/test.js`
+
+Use commonjs module system for wiring up files.
+
+### Declaration files
+**npmts** also creates declaration files like `./dist/index.d.ts` by default.
+You can reference it in your package.json like this.
+
+```json
+"main": "dist/index.js",
+"typings": ".dist/index.d.ts",
+```
+
+This is in line with the latest TypeScript best practices.
+You can then import plugins via the TypeScript `import` Syntax
+and tsc will pick up the declaration file automatically.
+
+### TypeDoc
+By default TypeDoc will create docs for your module in `./pages/api/` directory.
+> Note: Use [npmpage](https://www.npmjs.com/package/npmpage) to build a website for the module.
+It also allows you to integrate api docs with a gitbook located in `./docs/` 
+
+## Some notes:
+#### Typings for third party modules that do not bundle declaration files
+NPMTS no longer supports typings.json. Instead use the new TypeScript 2.x approach to typings using the @types/ npm scope.
+
+#### Instrumentalize Code
+npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
+
+#### Tests
+Any errors will be shown with reference to their originating source in TypeScript
+thanks to autogenerated source maps.
+
+## Example Usage in modules:
+* [gulp-browser](https://www.npmjs.com/package/gulp-browser)
+
+> We will add more options over time.
+
+## Tips and tricks:
+
+* Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available.
+* Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module
+* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds
+* Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker.
+
+## Future Scope:
+* automatically manage badges in README
+* manage tslint to enforce code best practices
+* tear down any differences between local and CI environments by using brand new npmdocker
+
+## About the authors:
+[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
+
+[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)

package.json

@@ -1,18 +1,21 @@
 {
   "name": "npmts",
-  "version": "5.3.28",
+  "version": "5.4.19",
   "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
   "main": "dist/index.js",
   "bin": {
     "npmts": "dist/cli.js"
   },
   "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/ )",
     "setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
-    "check": "(cd test && node ../dist/index.js)",
+    "typedoc": "(typedoc --out ./pages/api --target ES6 ./ts/)",
+    "npmpage": "(npmpage)",
+    "check": "(cd test && npm install && node ../dist/index.js)",
     "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": {
     "type": "git",
@@ -29,39 +32,37 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmts#readme",
   "dependencies": {
+    "@types/gulp": "^3.8.30",
     "@types/minimatch": "^2.0.28",
-    "@types/q": "^0.0.27",
-    "@types/shelljs": "^0.3.27",
-    "babel-preset-es2015": "^6.9.0",
-    "beautylog": "5.0.18",
-    "early": "^2.0.13",
+    "@types/q": "^0.x.x",
+    "@types/shelljs": "^0.3.29",
+    "babel-preset-es2015": "^6.13.2",
+    "beautylog": "5.0.20",
+    "depcheck": "^0.6.4",
+    "early": "^2.0.25",
     "gulp": "3.9.1",
     "gulp-babel": "^6.1.2",
-    "gulp-concat": "^2.6.0",
     "gulp-function": "^1.3.6",
-    "gulp-if": "^2.0.1",
     "gulp-inject-modules": "^1.0.0",
-    "gulp-istanbul": "^1.0.0",
-    "gulp-mocha": "^2.2.0",
-    "gulp-replace": "^0.5.4",
+    "gulp-istanbul": "^1.1.0",
+    "gulp-mocha": "^3.0.1",
     "gulp-sourcemaps": "^1.6.0",
     "gulp-typedoc": "^2.0.0",
-    "lodash": "^4.14.0",
-    "npmextra": "^1.0.8",
+    "lodash": "^4.15.0",
+    "npmextra": "^1.0.9",
     "projectinfo": "1.0.3",
     "q": "^1.4.1",
-    "shelljs": "^0.7.2",
-    "smartci": "0.0.1",
+    "shelljs": "^0.7.3",
     "smartcli": "1.0.4",
-    "smartcov": "0.0.9",
+    "smartcov": "1.0.0",
     "smartenv": "1.2.5",
-    "smartfile": "4.0.12",
+    "smartfile": "4.0.13",
     "smartpath": "3.2.2",
-    "smartstring": "^2.0.15",
+    "smartstring": "^2.0.17",
     "source-map-support": "^0.4.2",
-    "tsn": "^1.0.9",
-    "typedoc": "^0.4.4",
-    "typescript": "^2.0.0-dev.20160630",
+    "tsn": "^1.0.12",
+    "typedoc": "^0.4.5",
+    "typescript": "next",
     "typings-global": "*"
   },
   "devDependencies": {}

ts/npmts.check.ts

@@ -0,0 +1,117 @@
+import * as plugins from "./npmts.plugins";
+import * as paths from "./npmts.paths";
+import { npmtsOra } from "./npmts.promisechain";
+
+let checkProjectTypings = (configArg) => {
+    let done = plugins.Q.defer();
+    let cwdProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.cwd);
+    if(typeof cwdProjectInfo.packageJson.typings == "undefined"){
+        plugins.beautylog.error(`please add typings field to package.json`);
+        process.exit(1);
+    };
+    done.resolve(configArg);
+    return done.promise;
+};
+
+const depcheckOptions = {
+    ignoreBinPackage: false, // ignore the packages with bin entry
+    parsers: { // the target parsers
+        '*.ts': plugins.depcheck.parser.typescript,
+    },
+    detectors: [ // the target detectors
+        plugins.depcheck.detector.requireCallExpression,
+        plugins.depcheck.detector.importDeclaration
+    ],
+    specials: [ // the target special parsers
+        plugins.depcheck.special.eslint,
+        plugins.depcheck.special.webpack
+    ],
+};
+
+let checkDependencies = (configArg) => {
+    let done = plugins.Q.defer();
+    let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
+        ignoreDirs: [ // folder with these names will be ignored
+            'test',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [ // ignore dependencies that matches these globs
+            "@types/*",
+            "babel-preset-*"
+        ]
+    })
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
+        for (let item of unused.dependencies) {
+            plugins.beautylog.warn(`Watch out: unused dependency ${item.red}`);
+        };
+        for (let item of unused.missing) {
+            plugins.beautylog.error(`unused devDependency ${item.red}`);
+        };
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info("exiting due to missing dependencies in package.json");
+            process.exit(1);
+        }
+        for (let item of unused.invalidFiles) {
+            plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
+        };
+        for (let item of unused.invalidDirs) {
+            plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
+        };
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+
+let checkDevDependencies = (configArg) => {
+    let done = plugins.Q.defer();
+    let depcheckOptionsMerged = plugins.lodashObject.merge(depcheckOptions, {
+        ignoreDirs: [ // folder with these names will be ignored
+            'ts',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [ // ignore dependencies that matches these globs
+            "@types/*",
+            "babel-preset-*"
+        ]
+    })
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, (unused) => {
+        for (let item of unused.devDependencies) {
+            plugins.beautylog.log(`unused devDependency ${item.red}`);
+        };
+        for (let item of unused.missing) {
+            plugins.beautylog.error(`unused devDependency ${item.red}`);
+        };
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info("exiting due to missing dependencies in package.json");
+            process.exit(1);
+        }
+        for (let item of unused.invalidFiles) {
+            plugins.beautylog.warn(`Watch out: could not parse file ${item.red}`);
+        };
+        for (let item of unused.invalidDirs) {
+            plugins.beautylog.warn(`Watch out: could not parse directory ${item.red}`);
+        };
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+
+let checkNodeVersion = (configArg) => {
+    let done = plugins.Q.defer();
+
+    done.resolve(configArg);
+    return done.promise;
+}
+
+export let run = (configArg) => {
+    let done = plugins.Q.defer();
+    npmtsOra.text("running project checks..."),
+        checkProjectTypings(configArg)
+            .then(checkDependencies)
+            .then(checkDevDependencies)
+            .then(checkNodeVersion)
+            .then(done.resolve);
+    return done.promise;
+}

ts/npmts.clean.ts

@@ -4,27 +4,20 @@ import paths = require("./npmts.paths");
 import {npmtsOra} from "./npmts.promisechain";
 
 let removeDist = function(){
-    npmtsOra.text("cleaning " + "dist".yellow + " folder");
+    npmtsOra.text("cleaning dist folder");
     return plugins.smartfile.fs.remove(paths.distDir);
 };
 
-let removeTypings = function(){
-    let done = plugins.Q.defer();
-    npmtsOra.text("cleaning " + "typings".yellow + " folder");
-    if(false){
-        //plugins.smartfile.fsaction.remove(paths.typingsDir)
-        //    .then(done.resolve);
-    } else {
-        done.resolve();
-    }
-    return done.promise;
+let removePages = function(){
+    npmtsOra.text("cleaning pages folder");
+    return plugins.smartfile.fs.remove(paths.pagesDir);
 };
 
 export let run = function(configArg){
     npmtsOra.text("cleaning up from previous builds...");
     let done = plugins.Q.defer();
     removeDist()
-        .then(removeTypings)
+        .then(removePages)
         .then(function(){
             plugins.beautylog.ok("Cleaned up from previous builds!");
             done.resolve(configArg);

ts/npmts.configfile.ts

@@ -1,32 +0,0 @@
-import "typings-global";
-import plugins = require("./npmts.plugins");
-import paths = require("./npmts.paths");
-import {npmtsOra} from "./npmts.promisechain";
-export var run = function(argvArg){
-    let done = plugins.Q.defer();
-    npmtsOra.text("looking for npmextra.json");
-    let defaultConfig = {
-        mode: "default",
-        notest:false
-    };
-    if(argvArg.notest){
-        defaultConfig.notest = true;
-    };
-    let config = plugins.npmextra.dataFor({
-        toolName:"npmts",
-        defaultSettings:defaultConfig,
-        cwd:paths.cwd
-    });
-    switch (config.mode){
-        case "default":
-        case "custom":
-            plugins.beautylog.ok("mode is " + config.mode.yellow);
-            done.resolve(config);
-            break;
-        default:
-            plugins.beautylog.error("mode " + config.mode.yellow + " not recognised!".red);
-            process.exit(1);
-    };
-    done.resolve(config);
-    return done.promise;
-};

ts/npmts.options.ts

@@ -1,40 +1,79 @@
 import "typings-global";
 import plugins = require("./npmts.plugins");
+import paths = require("./npmts.paths");
 import {npmtsOra} from "./npmts.promisechain";
 
-export let isCi = function(){
-    return plugins.smartci.check.isCi();
+export type npmtsMode = "default" | "custom"
+
+export interface npmtsConfig {
+        argv:any,
+        coverageTreshold:number,
+        docs:boolean,
+        mode: npmtsMode,
+        test:boolean,
+        testTs:any,
+        ts:any,
+        tsOptions:any
+        
 };
 
-export var run = function(configArg){
-    var done = plugins.Q.defer();
-    var config = configArg;
 
-    npmtsOra.text("now determining build options...");
+export var run = function(argvArg){
+    let done = plugins.Q.defer();
+    let defaultConfig:npmtsConfig = {
+        argv:undefined,
+        coverageTreshold: 70,
+        docs: true,
+        mode:"default",
+        test:true,
+        testTs:{},
+        ts:{},
+        tsOptions: {}
+    };
+
+
+    // mix with configfile
+    npmtsOra.text("looking for npmextra.json");
+    let config:npmtsConfig = plugins.npmextra.dataFor({
+        toolName:"npmts",
+        defaultSettings:defaultConfig,
+        cwd:paths.cwd
+    });
+
+    // add argv
+    config.argv = argvArg;
+
+    // check mode
+    switch (config.mode){
+        case "default":
+        case "custom":
+            plugins.beautylog.ok("mode is " + config.mode);
+            done.resolve(config);
+            break;
+        default:
+            plugins.beautylog.error(`mode not recognised!`);
+            process.exit(1);
+    };
 
     //handle default mode
     if (config.mode == "default"){
-        config.typings = [
-            "./ts/typings.json"
-        ];
         config.ts = {
             ["./ts/**/*.ts"]: "./dist/"
         };
         config.testTs = {
             ["./test/test.ts"]: "./test/"
         };
-        config.test = ["./index.js"];
-    }
-    
-    //check if config.tsOptions is available
-    config.tsOptions ? void(0) : config.tsOptions = {};
+    };
 
-    
 
-    config.coverageTreshold ? void(0) : config.coverageTreshold = 70;
+    // mix with commandline
+    if(config.argv.notest){
+        config.test = false;
+    };
+    if(config.argv.nodocs){
+        config.docs = false;
+    };
 
-    // handle docs
-    config.docs ? void(0) : config.docs = {};
 
     plugins.beautylog.ok("build options are ready!");
     done.resolve(config);

ts/npmts.paths.ts

@@ -1,21 +1,24 @@
 import "typings-global";
 import plugins = require("./npmts.plugins");
 
-//Npmts Paths
+// NPMTS Paths
 export let npmtsPackageRoot = plugins.path.join(__dirname,"../");
 
 
-//Project paths
+// Project paths
 export let cwd = process.cwd();
 
-//Directories
+// Directories
 export let tsDir = plugins.path.join(cwd,"ts/");
 export let distDir = plugins.path.join(cwd,"dist/");
-export let docsDir = plugins.path.join(cwd,"docs/");
 export let testDir = plugins.path.join(cwd,"test/");
 export let typingsDir = plugins.path.join(cwd,"ts/typings/");
 export let coverageDir = plugins.path.join(cwd,"coverage/");
 
+// Pages
+export let pagesDir = plugins.path.join(cwd,"pages/");
+export let pagesApiDir = plugins.path.join(pagesDir,"/api");
+
 export let npmtsAssetsDir = plugins.path.join(__dirname,"../assets/");
 
 //Files

ts/npmts.plugins.ts

@@ -1,13 +1,13 @@
 import "typings-global";
 export import beautylog = require("beautylog");
-export let gulp = require("gulp");
+export let depcheck = require("depcheck");
+export import gulp = require("gulp");
 export let g = {
     babel: require("gulp-babel"),
     istanbul: require("gulp-istanbul"),
     gFunction: require("gulp-function"),
     injectModules: require("gulp-inject-modules"),
     mocha: require("gulp-mocha"),
-    replace: require("gulp-replace"),
     sourcemaps: require("gulp-sourcemaps"),
     typedoc: require("gulp-typedoc")
 };
@@ -17,7 +17,6 @@ export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");
 export import shelljs = require("shelljs");
-export let smartci = require("smartci");
 export import smartcli = require("smartcli");
 export import smartcov = require("smartcov");
 export import smartenv = require("smartenv");

ts/npmts.promisechain.ts

@@ -5,9 +5,9 @@ import {Ora} from "beautylog"
 export let npmtsOra = new plugins.beautylog.Ora("setting up TaskChain","cyan");
 
 import NpmtsAssets = require("./npmts.assets");
+import NpmtsCheck = require("./npmts.check");
 import NpmtsClean = require("./npmts.clean");
 import NpmtsCompile = require("./npmts.compile");
-import NpmtsConfigFile = require("./npmts.configfile");
 import NpmtsTypeDoc = require("./npmts.typedoc");
 import NpmtsOptions = require("./npmts.options");
 import NpmtsTests = require("./npmts.tests");
@@ -15,9 +15,9 @@ import NpmtsTests = require("./npmts.tests");
 export let promisechain = function(argvArg){
     let done = plugins.Q.defer();
     npmtsOra.start();
-    NpmtsConfigFile.run(argvArg)
-        .then(NpmtsOptions.run)
+    NpmtsOptions.run(argvArg)
         .then(NpmtsClean.run)
+        .then(NpmtsCheck.run)
         .then(NpmtsCompile.run)
         .then(NpmtsAssets.run)
         .then(NpmtsTypeDoc.run)

ts/npmts.tests.ts

@@ -26,7 +26,7 @@ let mocha = function (configArg) {
             plugins.gulp.src([plugins.path.join(paths.cwd,"test/test.js")])
             .pipe(plugins.g.babel({
                 presets: [
-                    plugins.path.join(paths.npmtsPackageRoot,"node_modules/babel-preset-es2015/index.js")
+                    require.resolve("babel-preset-es2015")
                 ]
             }))
             .pipe(plugins.g.injectModules())
@@ -66,7 +66,7 @@ let coverage = function(configArg){
 export let run = function(configArg) {
     let done = plugins.Q.defer();
     let config = configArg;
-    if(config.notest != true){
+    if(config.test === true){
         npmtsOra.text("now starting tests");
         plugins.beautylog.log(
             "-------------------------------------------------------\n" +

ts/npmts.typedoc.ts

@@ -1,40 +1,44 @@
 import "typings-global";
 import plugins = require("./npmts.plugins");
 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();
     npmtsOra.text("now generating " + "TypeDoc documentation".yellow);
     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({
-			// 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",
-			
+            // 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: "my-project",
+
             //theme: "default",
-			ignoreCompilerErrors: true,
-			version: true,
-		}))
-        .pipe(plugins.g.gFunction(done.resolve,"atEnd"));
+            ignoreCompilerErrors: true,
+            version: true,
+        }))
+        .pipe(plugins.g.gFunction(done.resolve, "atEnd"));
     return done.promise;
 };
 
 
-export let run = function(configArg){
+export let run = function (configArg) {
     let done = plugins.Q.defer();
-    genTypeDoc(configArg)
-        .then(() => {
-            done.resolve(configArg);
-        });
+    if (configArg.docs) {
+        genTypeDoc(configArg)
+            .then(() => {
+                done.resolve(configArg);
+            });
+    } else {
+        done.resolve(configArg);
+    };
     return done.promise;
 };