5.1.2

README.md

@@ -11,6 +11,9 @@ Write npm modules with TypeScript without hassle.
 ## What is NPMTS?
 NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
 
+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/)
+
 ### Install
 First install npmts as dev dependency:
 
@@ -45,9 +48,46 @@ Then use it in package.json's script section to trigger a build:
 #### npmts.json
 the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
 
+```json
+{
+  "mode":"default",
+  "ts":{
+    "./customdir/*.ts":"./"
+  },
+  "tsOptions":{
+    "declaration":false,
+    "target":"ES6"
+  },
+  "typings":[
+    "./ts/typings.json",
+    "./subts1/typings.json",
+    "./subts2/typings.json",
+    "./customdir/typings.json"
+  ],
+  "typingsInclude":"auto",
+  "codecov":true,
+  "docs": {
+    "publish":true
+  },
+  "cli":true
+}
+```
+
+| key | description |
+| --- | --- |
+| codecov | if true, coverage data will be uploaded to codecov when running on travis |
+| docs | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
+| mode | "default" will do some defualt stuff, "custom" only does what you specify |
+| tsOptions | specify options for tsc |
+|  |  |
+
 #### Typings
 **npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
-You can then reference the ./ts/typings/main.d.ts file in any of your TypeScript code.
+
+> 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
@@ -56,17 +96,20 @@ 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 `index.d.ts` declaration file by default.
-You can reference it in your package.json like this:
+**npmts** also creates an `./dist/index.d.ts` declaration file by default.
+You can reference it in your package.json like this.
 
 ```json
-"main": "index.js",
-"typings": "./index.d.ts",
+"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.
 
+> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
+
 #### Instrumentalize Code
 npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
 

dist/npmts.compile.helpers.js

@@ -0,0 +1,16 @@
+"use strict";
+var plugins = require("./npmts.plugins");
+var paths = require("./npmts.paths");
+var outputPathIsDir = function (configArg, keyArg) {
+    return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, configArg.ts[keyArg]));
+};
+exports.checkOutputPath = function (configArg, keyArg) {
+    if (!outputPathIsDir(configArg, keyArg)) {
+        plugins.beautylog.warn("Skipping " + keyArg + " because " + configArg.ts[keyArg] + " it is no directory!");
+        return false;
+    }
+    else {
+        return true;
+    }
+    ;
+};

dist/npmts.compile.js

@@ -2,6 +2,7 @@
 /// <reference path="./typings/main.d.ts" />
 var plugins = require("./npmts.plugins");
 var paths = require("./npmts.paths");
+var helpers = require("./npmts.compile.helpers");
 exports.run = function (configArg) {
     var done = plugins.Q.defer();
     var config = configArg;
@@ -10,53 +11,44 @@ exports.run = function (configArg) {
     /* -------------------------------------------------
      * ----------- compile TypeScript --------------------------
      * ----------------------------------------------- */
-    for (var key in config.ts) {
-        var outputPathIsDir;
-        try {
-            if (plugins.fs.statSync(plugins.path.join(paths.cwd, config.ts[key])).isDirectory()) {
-                outputPathIsDir = true;
-            }
+    var tsOptionsDefault = {
+        declaration: true,
+        target: "ES5",
+        module: "commonjs"
+    };
+    /**
+     * merges default ts options with those found in npmts.json
+     */
+    var tsOptions = function (keyArg) {
+        return plugins.lodashObject.assign(tsOptionsDefault, config.tsOptions);
+    };
+    for (var keyArg in config.ts) {
+        if (helpers.checkOutputPath(config, keyArg)) {
+            var tsStream = plugins.gulp.src([plugins.path.join(paths.cwd, keyArg), "!**/typings/**"])
+                .pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
+                .pipe(plugins.g.typescript(tsOptions(keyArg)));
+            var jsStream = tsStream.js
+                .pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
+                .pipe(plugins.gulp.dest(config.ts[keyArg]));
+            var declarationStream = tsStream.dts
+                .pipe(plugins.gulp.dest(config.ts[keyArg]));
+            moduleStream.add(tsStream, jsStream, declarationStream);
         }
-        catch (err) {
-            outputPathIsDir = false;
-        }
-        //do some evaluation of the environment
-        var outputNameSpecified = (!outputPathIsDir
-            && (plugins.path.extname(config.ts[key]) == ".js"));
-        var outputName = (function () {
-            if (outputNameSpecified) {
-                return plugins.path.basename(config.ts[key]);
-            }
-            else {
-                return undefined;
-            }
-        })();
-        var outputDir = (function () {
-            if (outputNameSpecified) {
-                return plugins.path.dirname(plugins.path.join(paths.cwd, config.ts[key]));
-            }
-            else {
-                return plugins.path.join(paths.cwd, config.ts[key]);
-            }
-        })();
-        var stream = plugins.gulp.src([plugins.path.join(paths.cwd, key), "!**/typings/**"])
-            .pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
-            .pipe(plugins.g.typescript({
-            out: outputName,
-            target: "ES5",
-            module: "commonjs"
-        }))
-            .pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
-            .pipe(plugins.gulp.dest(outputDir));
-        moduleStream.add(stream);
     }
     moduleStream.on("queueDrain", function () {
         plugins.beautylog.ok("TypeScript has been compiled!");
         moduleStream.on("finish", function () {
+            try {
+                if (config.mode = "default")
+                    plugins.fs.copySync(plugins.path.join(paths.cwd, "ts/typings"), plugins.path.join(paths.cwd, "dist/typings"));
+            }
+            catch (err) {
+                plugins.beautylog.warn("failed to copy external typings for full module declaration support");
+            }
             done.resolve(config);
         });
         moduleStream.end();
     });
-    /*==================== END TYPESCRIPT =====================*/
+    /*==================== END TS Compilation =====================*/
     return done.promise;
 };

dist/npmts.options.js

@@ -28,6 +28,8 @@ exports.run = function (configArg) {
         );
         config.test = ["./index.js"];
     }
+    //check if config.tsOptions is available
+    config.tsOptions ? void (0) : config.tsOptions = {};
     // handle state of current build
     exports.isRelease() ? plugins.beautylog.info("All right: This is a RELEASE build!")
         : plugins.beautylog.info("NOT A RELEASE build!");

dist/npmts.plugins.js

@@ -13,6 +13,7 @@ exports.g = {
     typescript: require("gulp-typescript"),
     typings: require("gulp-typings")
 };
+exports.lodashObject = require('lodash/fp/object');
 exports.merge2 = require("merge2");
 exports.projectinfo = require("projectinfo");
 exports.path = require("path");
@@ -24,4 +25,4 @@ exports.smartcov = require("smartcov");
 exports.smartenv = require("smartenv");
 exports.smartfile = require("smartfile");
 exports.smartpath = require("smartpath");
-exports.sourceMapSupport = require("source-map-support").install();
+exports.sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "5.0.0",
+  "version": "5.1.2",
   "description": "write npm modules with TypeScript",
   "main": "dist/index.js",
   "bin": {
@@ -25,29 +25,30 @@
   },
   "homepage": "https://github.com/pushrocks/npmts#readme",
   "dependencies": {
-    "beautylog": "4.0.0",
-    "fs-extra": "^0.26.7",
+    "beautylog": "4.1.2",
+    "fs-extra": "^0.30.0",
     "gulp": "3.9.1",
     "gulp-codecov": "^2.0.1",
     "gulp-concat": "^2.6.0",
-    "gulp-function": "^1.2.0",
+    "gulp-function": "^1.3.1",
     "gulp-if": "^2.0.0",
-    "gulp-istanbul": "^0.10.3",
+    "gulp-istanbul": "^0.10.4",
     "gulp-jsdoc3": "^0.2.1",
     "gulp-mocha": "^2.2.0",
-    "gulp-sourcemaps": "^1.6.0",
-    "gulp-typescript": "2.12.2",
-    "gulp-typings": "1.3.0",
+    "gulp-sourcemaps": "^2.0.0-alpha",
+    "gulp-typescript": "2.13.0",
+    "gulp-typings": "1.3.4",
+    "lodash": "^4.11.1",
     "merge2": "1.0.2",
     "projectinfo": "1.0.1",
     "q": "^1.4.1",
-    "shelljs": "^0.6.0",
+    "shelljs": "^0.7.0",
     "smartci": "0.0.1",
     "smartcli": "0.0.11",
-    "smartcov": "0.0.4",
-    "smartenv": "1.2.1",
-    "smartfile": "2.3.0",
-    "smartpath": "3.1.1",
+    "smartcov": "0.0.6",
+    "smartenv": "1.2.2",
+    "smartfile": "3.0.5",
+    "smartpath": "3.1.5",
     "source-map-support": "^0.4.0"
   },
   "devDependencies": {}

test/assets/dist/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference path="typings/main.d.ts" />
+declare let testplugin: {
+    logSomething: () => void;
+};

test/assets/dist/index.js

@@ -6,4 +6,4 @@ var testplugin = {
 };
 module.exports = testplugin;
 
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0QztBQUM1QyxJQUFJLFVBQVUsR0FBRztJQUNiLFlBQVksRUFBRTtRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0osQ0FBQztBQUNGLE1BQU0sQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxubGV0IHRlc3RwbHVnaW4gPSB7XG4gICAgbG9nU29tZXRoaW5nOiBmdW5jdGlvbigpe1xuICAgICAgICBjb25zb2xlLmxvZyhcIm9ubHkgZnVuY3Rpb24gZXhlY3V0ZWRcIik7XG4gICAgfVxufTtcbm1vZHVsZS5leHBvcnRzID0gdGVzdHBsdWdpbjsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDRDQUE0QztBQUM1QyxJQUFJLFVBQVUsR0FBRztJQUNiLFlBQVksRUFBRTtRQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsd0JBQXdCLENBQUMsQ0FBQztJQUMxQyxDQUFDO0NBQ0osQ0FBQztBQUNGLE1BQU0sQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDIiwiZmlsZSI6ImluZGV4LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4vdHlwaW5ncy9tYWluLmQudHNcIiAvPlxubGV0IHRlc3RwbHVnaW4gPSB7XG4gICAgbG9nU29tZXRoaW5nOiBmdW5jdGlvbigpe1xuICAgICAgICBjb25zb2xlLmxvZyhcIm9ubHkgZnVuY3Rpb24gZXhlY3V0ZWRcIik7XG4gICAgfVxufTtcbm1vZHVsZS5leHBvcnRzID0gdGVzdHBsdWdpbjsiXX0=

test/assets/npmts.json

@@ -3,6 +3,9 @@
   "ts":{
     "./customdir/*.ts":"./"
   },
+  "tsOptions":{
+    "target":"ES5"
+  },
   "typings":[
     "./ts/typings.json",
     "./subts1/typings.json",

test/assets/test/test.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="../ts/typings/main.d.ts" />
+declare var testplugin: any;

test/assets/test/test.js

@@ -8,4 +8,4 @@ describe("testplugins", function () {
     });
 });
 
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZ0RBQWdEO0FBQ2hELElBQUksVUFBVSxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0FBQzdDLFFBQVEsQ0FBQyxhQUFhLEVBQUM7SUFDbkIsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixFQUFFLENBQUMsc0JBQXNCLEVBQUM7WUFDdEIsVUFBVSxDQUFDLFlBQVksRUFBRSxDQUFBO1FBQzdCLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyIsImZpbGUiOiJ0ZXN0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4uL3RzL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbnZhciB0ZXN0cGx1Z2luID0gcmVxdWlyZShcIi4uL2Rpc3QvaW5kZXguanNcIik7XG5kZXNjcmliZShcInRlc3RwbHVnaW5zXCIsZnVuY3Rpb24oKXtcbiAgICBkZXNjcmliZShcIi5sb2dTb21ldGhpbmdcIixmdW5jdGlvbigpe1xuICAgICAgICBpdChcInNob3VsZCBsb2cgc29tZXRoaW5nXCIsZnVuY3Rpb24oKXtcbiAgICAgICAgICAgIHRlc3RwbHVnaW4ubG9nU29tZXRoaW5nKClcbiAgICAgICAgfSk7XG4gICAgfSk7XG59KTsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
+//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZ0RBQWdEO0FBQ2hELElBQUksVUFBVSxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0FBQzdDLFFBQVEsQ0FBQyxhQUFhLEVBQUM7SUFDbkIsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixFQUFFLENBQUMsc0JBQXNCLEVBQUM7WUFDdEIsVUFBVSxDQUFDLFlBQVksRUFBRSxDQUFBO1FBQzdCLENBQUMsQ0FBQyxDQUFDO0lBQ1AsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyIsImZpbGUiOiJ0ZXN0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4uL3RzL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbnZhciB0ZXN0cGx1Z2luID0gcmVxdWlyZShcIi4uL2Rpc3QvaW5kZXguanNcIik7XG5kZXNjcmliZShcInRlc3RwbHVnaW5zXCIsZnVuY3Rpb24oKXtcbiAgICBkZXNjcmliZShcIi5sb2dTb21ldGhpbmdcIixmdW5jdGlvbigpe1xuICAgICAgICBpdChcInNob3VsZCBsb2cgc29tZXRoaW5nXCIsZnVuY3Rpb24oKXtcbiAgICAgICAgICAgIHRlc3RwbHVnaW4ubG9nU29tZXRoaW5nKClcbiAgICAgICAgfSk7XG4gICAgfSk7XG59KTsiXX0=

ts/npmts.compile.helpers.ts

@@ -0,0 +1,15 @@
+import plugins = require("./npmts.plugins");
+import paths = require("./npmts.paths");
+
+let outputPathIsDir = function (configArg,keyArg) {
+        return plugins.smartpath.check.isDir(plugins.path.join(paths.cwd, configArg.ts[keyArg]));
+};
+
+export let checkOutputPath = function(configArg,keyArg){
+    if(!outputPathIsDir(configArg,keyArg)) {
+        plugins.beautylog.warn("Skipping " + keyArg + " because " + configArg.ts[keyArg] + " it is no directory!")
+        return false
+    } else {
+        return true;
+    };
+}

ts/npmts.compile.ts

@@ -1,67 +1,64 @@
 /// <reference path="./typings/main.d.ts" />
 import plugins = require("./npmts.plugins");
 import paths = require("./npmts.paths");
-export var run = function(configArg){
-    var done = plugins.Q.defer();
-    var config = configArg;
+
+import helpers = require("./npmts.compile.helpers");
+
+export let run = function (configArg) {
+    let done = plugins.Q.defer();
+    let config = configArg;
     plugins.beautylog.log("now compiling " + "TypeScript".yellow);
-    var moduleStream = plugins.merge2({end: false});
+    let moduleStream = plugins.merge2({ end: false });
 
     /* -------------------------------------------------
      * ----------- compile TypeScript --------------------------
      * ----------------------------------------------- */
-    for (var key in config.ts) {
-        var outputPathIsDir:boolean;
-        try {
-            if(plugins.fs.statSync(plugins.path.join(paths.cwd,config.ts[key])).isDirectory()){
-                outputPathIsDir = true;
-            }
-        }
-        catch(err) {
-            outputPathIsDir = false;
-        }
-        //do some evaluation of the environment
-        var outputNameSpecified:boolean = (
-            !outputPathIsDir
-            && (plugins.path.extname(config.ts[key]) == ".js")
-        );
-        var outputName = (function(){
-            if(outputNameSpecified){
-                return plugins.path.basename(config.ts[key])
-            } else {
-                return undefined
-            }
-        })();
-        var outputDir = (function(){
-            if(outputNameSpecified){
-                return plugins.path.dirname(
-                    plugins.path.join(paths.cwd,config.ts[key])
-                )
-            } else {
-                return plugins.path.join(paths.cwd,config.ts[key])
-            }
-        })();
 
-        var stream = plugins.gulp.src([plugins.path.join(paths.cwd,key),"!**/typings/**"])
-            .pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
-            .pipe(plugins.g.typescript({
-                out: outputName,
-                target: "ES5",
-                module: "commonjs"
-            }))
-            .pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
-            //.pipe(plugins.g.header('#!/usr/bin/env node\n\n'))
-            .pipe(plugins.gulp.dest(outputDir));
-        moduleStream.add(stream);
+    let tsOptionsDefault = {
+        declaration: true,
+        target: "ES5",
+        module: "commonjs"
+    };
+    
+    /**
+     * merges default ts options with those found in npmts.json
+     */
+    let tsOptions = function (keyArg:string) {
+        return plugins.lodashObject.assign(tsOptionsDefault, config.tsOptions)
+    };
+
+    for (let keyArg in config.ts) {
+        if (helpers.checkOutputPath(config,keyArg)) {
+            let tsStream = plugins.gulp.src([plugins.path.join(paths.cwd, keyArg), "!**/typings/**"])
+                .pipe(plugins.g.sourcemaps.init()) // This means sourcemaps will be generated
+                .pipe(plugins.g.typescript(tsOptions(keyArg)));
+            
+            let jsStream = tsStream.js
+                .pipe(plugins.g.sourcemaps.write()) // Now the sourcemaps are added to the .js file
+                .pipe(plugins.gulp.dest(config.ts[keyArg]));
+            let declarationStream = tsStream.dts
+                .pipe(plugins.gulp.dest(config.ts[keyArg])); 
+            moduleStream.add(tsStream,jsStream,declarationStream);
+        }
     }
-    moduleStream.on("queueDrain",function(){
+
+    moduleStream.on("queueDrain", function () {
         plugins.beautylog.ok("TypeScript has been compiled!");
-        moduleStream.on("finish",function(){
+        moduleStream.on("finish", function () {
+            try {
+                if(config.mode = "default") plugins.fs.copySync(
+                    plugins.path.join(paths.cwd,"ts/typings"),
+                    plugins.path.join(paths.cwd,"dist/typings")
+                );
+            }
+            catch (err){
+                plugins.beautylog.warn("failed to copy external typings for full module declaration support");
+            }
             done.resolve(config);
         });
         moduleStream.end();
     });
-    /*==================== END TYPESCRIPT =====================*/
+    /*==================== END TS Compilation =====================*/
 
 
 

ts/npmts.options.ts

@@ -32,6 +32,9 @@ export var run = function(configArg){
         };
         config.test = ["./index.js"];
     }
+    
+    //check if config.tsOptions is available
+    config.tsOptions ? void(0) : config.tsOptions = {};
 
     // handle state of current build
 

ts/npmts.plugins.ts

@@ -13,6 +13,7 @@ export let g = {
     typings: require("gulp-typings")
 
 };
+export let lodashObject = require('lodash/fp/object');
 export let merge2 = require("merge2");
 export let projectinfo = require("projectinfo");
 export let path = require("path");
@@ -24,4 +25,4 @@ export let smartcov = require("smartcov");
 export let smartenv = require("smartenv");
 export let smartfile = require("smartfile");
 export let smartpath = require("smartpath");
-export let sourceMapSupport = require("source-map-support").install();
+export let sourceMapSupport = require("source-map-support").install(); // this is required to display errors correctly during testing