5.3.21

.gitlab-ci.yml

@@ -45,17 +45,3 @@ trigger:
     - tags
   tags:
     - docker
-    
-pages:
-  stage: page
-  script:
-  - npmci test lts
-  - mkdir .public
-  - cp -r test/assets/docs/ .public
-  - cp -r test/assets/coverage/ .public
-  - mv .public public
-  artifacts:
-    paths:
-    - public
-  only:
-  - tags

README.md

@@ -3,7 +3,6 @@ Write npm modules with TypeScript without hassle.
 
 ## Status
 [![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
-[![Build status](https://ci.appveyor.com/api/projects/status/22fuqa0uv21rcjh4/branch/master?svg=true)](https://ci.appveyor.com/project/philkunz/npmts/branch/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)
@@ -14,10 +13,13 @@ NPMTS is your friend when it comes to write, test, publish and document NPM modu
 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-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/)
+[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 checker:
+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
@@ -28,51 +30,35 @@ Then add it to your package.json's script section to trigger a build:
 
 ```json
 "scripts": {
-    "test": "npmts"
+    "test": "(npmts)"
 }
 ```
 
 ### Default task execution order
 
-1. Check config in ./npmts.json
+1. Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
 1. Clean up from any previous builds (old js files)
-1. Install typings
-1. Transpile TypeScript with **inline sourcemaps** and **declaration files** 
-1. Create JsDoc Documentation
-1. Instrumentalize created JavaScript files with istanbul
-1. Run Tests
-1. Create Coverage report
+1. Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
+1. Create TypeDoc Documentation from TypeScript files
+1. Instrumentalize transpiled ES6 JavaScript with istanbul and run tests with Mocha
 
-#### npmts.json
-the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
+#### npmtsextra.json
+the npmts section in npmtsextra.json can be used to configure npmts.
 
 ```json
 {
+  "npmts":{
     "mode":"default",
-  "codecov":{
-    "publish":true,
-    "token":"sometoken"
-  },
     "ts":{
       "./customdir/*.ts":"./"
     },
-  "docs": {
-    "publish":true,
-    "destination":"github"
-  },
     "tsOptions":{
       "declaration":false,
       "target":"ES6"
     },
-  "typings":[
-    "./ts/typings.json",
-    "./subts1/typings.json",
-    "./subts2/typings.json",
-    "./customdir/typings.json"
-  ],
-  "typingsInclude":"auto",
     "cli":true
   }
+}
 ```
 
 | key | default value | description |
@@ -84,14 +70,6 @@ the npmts.json is the main config file. You can use it to customize the behaviou
 | `"typings"` | `["./ts/typings.json"]` | allows you to specify multiple locations for typings.json to install. This is needed for modules that do not yet bundle typings |
 | `"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. |
 
-#### Typings
-**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
-
-> Note: You can reference the typings files in any of your TypeScript code with a  
-`/// <reference path="/some/path/main.d.ts">`  
-We are currently working on a "typingsInclude" option, that will autoload any typings during compilation.
-tsconfig is NOT supported, since it would render this module useless
-
 #### TypeScript
 by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
 `./dist/*.js` and `./test/test.js`
@@ -111,7 +89,8 @@ 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.
 
-> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
+#### 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.
 
 #### Instrumentalize Code
 npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
@@ -124,7 +103,6 @@ Any errors will be shown with reference to their originating source in TypeScrip
 thanks to autogenerated source maps.
 
 ## Example Usage in modules:
-* [gulp-typings](https://www.npmjs.com/package/gulp-typings)
 * [gulp-browser](https://www.npmjs.com/package/gulp-typings)
 
 > We will add more options over time.
@@ -132,7 +110,7 @@ thanks to autogenerated source maps.
 ## 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/npmtspage) to create a webpage from coverage reports and JsDocs for the module
+* Use [npmpage](https://www.npmjs.com/package/npmtspage) 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
 
 ## About the authors:

dist/npmts.cli.d.ts

@@ -1 +0,0 @@
-import "typings-global";

dist/npmts.cli.js

@@ -1,2 +0,0 @@
-"use strict";
-require("typings-global");

dist/npmts.compile.js

@@ -9,7 +9,7 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
     var done = plugins.Q.defer();
     var tsOptionsDefault = {
         declaration: true,
-        target: "ES5",
+        target: "ES6",
         module: "commonjs"
     };
     /**

dist/npmts.jsdoc.js

@@ -1,28 +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 genJsdoc = 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);
-    }));
-    return done.promise;
-};
-exports.run = function (configArg) {
-    var done = plugins.Q.defer();
-    genJsdoc(configArg)
-        .then(done.resolve);
-    return done.promise;
-};

dist/npmts.plugins.d.ts

@@ -2,14 +2,16 @@ import "typings-global";
 export import beautylog = require("beautylog");
 export declare let gulp: any;
 export declare let g: {
-    gFunction: any;
+    babel: any;
     istanbul: any;
-    jsdoc3: any;
+    gFunction: any;
+    injectModules: any;
     mocha: any;
     replace: any;
+    sourcemaps: any;
+    typedoc: any;
 };
 export declare let lodashObject: any;
-export declare let merge2: any;
 export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");

dist/npmts.plugins.js

@@ -3,14 +3,16 @@ require("typings-global");
 exports.beautylog = require("beautylog");
 exports.gulp = require("gulp");
 exports.g = {
-    gFunction: require("gulp-function"),
+    babel: require("gulp-babel"),
     istanbul: require("gulp-istanbul"),
-    jsdoc3: require("gulp-jsdoc3"),
+    gFunction: require("gulp-function"),
+    injectModules: require("gulp-inject-modules"),
     mocha: require("gulp-mocha"),
-    replace: require("gulp-replace")
+    replace: require("gulp-replace"),
+    sourcemaps: require("gulp-sourcemaps"),
+    typedoc: require("gulp-typedoc")
 };
 exports.lodashObject = require('lodash/fp/object');
-exports.merge2 = require("merge2");
 exports.projectinfo = require("projectinfo");
 exports.path = require("path");
 exports.Q = require("q");

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 = "" +

dist/npmts.tests.js

@@ -7,32 +7,38 @@ var npmts_promisechain_1 = require("./npmts.promisechain");
  *
  * @returns {*}
  */
-var istanbul = function (configArg) {
-    npmts_promisechain_1.npmtsOra.text("Instrumentalizing transpiled JS...");
+var mocha = function (configArg) {
+    npmts_promisechain_1.npmtsOra.text("Instrumentalizing and testing transpiled JS");
+    npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
     var done = plugins.Q.defer();
     var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
-        .pipe(plugins.g.istanbul()) // Covering files
-        .pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
-        .pipe(plugins.g.gFunction(function () {
-        plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
-        done.resolve(configArg);
-    }, "atEnd"));
-    return done.promise;
-};
-/**
- *
- * @returns {*}
- */
-var mocha = function (configArg) {
-    var done = plugins.Q.defer();
-    npmts_promisechain_1.npmtsOra.end(); // end npmtsOra for tests.
-    var stream = plugins.gulp.src(["./test/test.js"])
+        .pipe(plugins.g.sourcemaps.init())
+        .pipe(plugins.g.babel({
+        presets: [
+            require.resolve("babel-preset-es2015")
+        ]
+    }))
+        .pipe(plugins.g.istanbul({}))
+        .pipe(plugins.g.sourcemaps.write())
+        .pipe(plugins.g.injectModules())
+        .on("finish", function () {
+        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")
+            ]
+        }))
+            .pipe(plugins.g.injectModules())
             .pipe(plugins.g.mocha())
-        .pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
+            .pipe(plugins.g.istanbul.writeReports({
+            dir: './coverage',
+            reporters: ['lcovonly', 'json', 'text', 'text-summary']
+        }))
             .pipe(plugins.g.gFunction(function () {
-        plugins.beautylog.ok("Tests have passed!");
+            plugins.beautylog.ok("Tested!");
             done.resolve(configArg);
         }, "atEnd"));
+    });
     return done.promise;
 };
 var coverage = function (configArg) {
@@ -61,8 +67,7 @@ exports.run = function (configArg) {
         plugins.beautylog.log("-------------------------------------------------------\n" +
             "*************************** TESTS: ***************************\n" +
             "--------------------------------------------------------------");
-        istanbul(config)
-            .then(mocha)
+        mocha(config)
             .then(coverage)
             .then(function () {
             done.resolve(config);

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 " + "TypeDoc 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: true,
+        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;
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "5.3.5",
+  "version": "5.3.21",
   "description": "write npm modules with TypeScript",
   "main": "dist/index.js",
   "bin": {
@@ -12,8 +12,7 @@
     "setupCheck": "(git clone https://gitlab.com/sandboxzone/sandbox-npmts.git test/)",
     "check": "(cd test && node ../dist/index.js)",
     "checkVersion": "(cd test/ && node ../dist/index.js -v)",
-    "checkNoTest": "(cd test && node ../dist/index.js --notest)",
-    "install": "(mkdir test/)"
+    "checkNoTest": "(cd test && node ../dist/index.js --notest)"
   },
   "repository": {
     "type": "git",
@@ -30,21 +29,24 @@
   },
   "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": "*",
+    "@types/q": "*",
+    "@types/shelljs": "*",
+    "babel-preset-es2015": "^6.9.0",
+    "beautylog": "5.0.14",
     "early": "^2.0.13",
     "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-jsdoc3": "^0.3.0",
     "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",
     "q": "^1.4.1",
     "shelljs": "^0.7.0",
@@ -52,11 +54,12 @@
     "smartcli": "1.0.4",
     "smartcov": "0.0.6",
     "smartenv": "1.2.5",
-    "smartfile": "4.0.9",
+    "smartfile": "4.0.10",
     "smartpath": "3.2.2",
-    "smartstring": "^2.0.10",
-    "source-map-support": "^0.4.1",
-    "tsn": "^1.0.3",
+    "smartstring": "^2.0.14",
+    "source-map-support": "^0.4.2",
+    "tsn": "^1.0.7",
+    "typedoc": "^0.4.4",
     "typescript": "^2.0.0-dev.20160630",
     "typings-global": "*"
   },

ts/npmts.cli.ts

@@ -1 +0,0 @@
-import "typings-global";

ts/npmts.compile.ts

@@ -10,7 +10,7 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
 
     let tsOptionsDefault = {
         declaration: true,
-        target: "ES5",
+        target: "ES6",
         module: "commonjs"
     };
     

ts/npmts.jsdoc.ts

@@ -1,30 +0,0 @@
-import "typings-global";
-import plugins = require("./npmts.plugins");
-import paths = require("./npmts.paths");
-import {npmtsOra} from "./npmts.promisechain";
-
-let genJsdoc = 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)
-        }));
-    return done.promise;
-};
-
-
-export let run = function(configArg){
-    let done = plugins.Q.defer();
-    genJsdoc(configArg)
-        .then(done.resolve);
-    return done.promise;
-};

ts/npmts.plugins.ts

@@ -2,14 +2,16 @@ import "typings-global";
 export import beautylog = require("beautylog");
 export let gulp = require("gulp");
 export let g = {
-    gFunction: require("gulp-function"),
+    babel: require("gulp-babel"),
     istanbul: require("gulp-istanbul"),
-    jsdoc3: require("gulp-jsdoc3"),
+    gFunction: require("gulp-function"),
+    injectModules: require("gulp-inject-modules"),
     mocha: require("gulp-mocha"),
-    replace: require("gulp-replace")
+    replace: require("gulp-replace"),
+    sourcemaps: require("gulp-sourcemaps"),
+    typedoc: require("gulp-typedoc")
 };
 export let lodashObject = require('lodash/fp/object');
-export let merge2 = require("merge2");
 export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");

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 NpmtsJsdoc = require("./npmts.jsdoc");
+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(NpmtsJsdoc.run)
+        .then(NpmtsTypeDoc.run)
         .then(NpmtsTests.run)
         .then(function(configArg){
             let shipString = "" +

ts/npmts.tests.ts

@@ -7,33 +7,39 @@ import {npmtsOra} from "./npmts.promisechain";
  *
  * @returns {*}
  */
-let istanbul = function (configArg) {
-    npmtsOra.text("Instrumentalizing transpiled JS...");
+let mocha = function (configArg) {
+    npmtsOra.text("Instrumentalizing and testing transpiled JS");
+    npmtsOra.end(); // end npmtsOra for tests.
     let done = plugins.Q.defer();
     var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
-        .pipe(plugins.g.istanbul()) // Covering files
-        .pipe(plugins.g.istanbul.hookRequire()) // Force `require` to return covered files
-        .pipe(plugins.g.gFunction(function(){
-            plugins.beautylog.ok("JS has been instrumentalized to get test code coverage!");
-            done.resolve(configArg);
-        },"atEnd"));
-    return done.promise;
-};
-
-/**
- *
- * @returns {*}
- */
-let mocha = function (configArg) {
-    let done = plugins.Q.defer();
-    npmtsOra.end(); // end npmtsOra for tests.
-    let stream = plugins.gulp.src(["./test/test.js"])
+        .pipe(plugins.g.sourcemaps.init())
+        .pipe(plugins.g.babel({
+            presets: [
+                require.resolve("babel-preset-es2015")
+            ]
+        }))
+        .pipe(plugins.g.istanbul({
+        }))
+        .pipe(plugins.g.sourcemaps.write())
+        .pipe(plugins.g.injectModules())
+        .on("finish",function(){
+            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")
+                ]
+            }))
+            .pipe(plugins.g.injectModules())
             .pipe(plugins.g.mocha())
-        .pipe(plugins.g.istanbul.writeReports()) // Creating the reports after tests ran
+            .pipe(plugins.g.istanbul.writeReports({
+                dir: './coverage',
+                reporters: [ 'lcovonly', 'json', 'text', 'text-summary']
+            }))
             .pipe(plugins.g.gFunction(function(){
-            plugins.beautylog.ok("Tests have passed!");
+                plugins.beautylog.ok("Tested!");
                 done.resolve(configArg);
             },"atEnd"));
+        });
     return done.promise;
 };
 
@@ -70,8 +76,7 @@ export let run = function(configArg) {
             "--------------------------------------------------------------"
         );
 
-        istanbul(config)
-            .then(mocha)
+        mocha(config)
             .then(coverage)
             .then(() => {
                 done.resolve(config);

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 " + "TypeDoc 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: true,
+			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;
+};