5.3.26

README.md

@@ -1,5 +1,5 @@
 # npmts
-Write npm modules with TypeScript without hassle.
+Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
 
 ## Status
 [![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
@@ -36,48 +36,44 @@ Then add it to your package.json's script section to trigger a build:
 
 ### Default task execution order
 
-1. Check config in ./npmts.json
+1. **Config:** 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. **Clean:** Clean up from any previous builds (old js files)
-1. Install typings
+1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES6
-1. Transpile TypeScript with **inline sourcemaps** and **declaration files** 
+1. **Documentation:** Create TypeDoc Documentation from TypeScript files
-1. Create EsDoc Documentation
+1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha.
-1. Instrumentalize created JavaScript files with istanbul
-1. Run Tests
-1. Create Coverage report
 
-#### npmts.json
+### npmextra.json
-the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
+the npmts section in npmtsextra.json can be used to configure npmts.
 
 ```json
 {
-  "mode":"default",
+  "npmts":{
-  "ts":{
+    "mode":"default",
-    "./customdir/*.ts":"./"
+    "ts":{
-  },
+      "./customdir/*.ts":"./"
-  "tsOptions":{
+    },
-    "declaration":false,
+    "tsOptions":{
-    "target":"ES6"
+      "declaration":false,
-  },
+      "target":"ES6"
-  "cli":true
+    },
+    "cli":true
+  }
 }
 ```
 
 | key | default value | description |
 | --- | --- | --- |
-| `"codecov"` | `true` | if true, coverage data will be uploaded to codecov when running on travis |
+| `"mode"` | `"default"` | "default" will do some default stuff, "custom" only does what you specify |
-| `"docs"` | `{"publish":"false"}` | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
-| `"mode"` | `"default"` | "default" will do some defualt stuff, "custom" only does what you specify |
 | `"tsOptions"` | `{"target":"ES5", "declaration":"true"}` | specify options for tsc |
-| `"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. |
 
-#### TypeScript
+### 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
+### Declaration files
 **npmts** also creates an `./dist/index.d.ts` declaration file by default.
 You can reference it in your package.json like this.
 
@@ -90,6 +86,7 @@ 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.
 
+## 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.
 
@@ -97,22 +94,20 @@ NPMTS does no longer supports typings.json. Instead use the new TypeScript 2.x a
 npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
 
 #### Tests
-When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
-npmts looks for `.test/test.ts` which will be transpiled to test.js and run with mocha. 
-
 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-typings)
+* [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/npmtspage) to create a webpage from coverage reports and EsDocs for the module
+* 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.
 
 ## About the authors:
 [![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)

dist/npmts.assets.js

@@ -8,11 +8,12 @@ exports.run = function (configArg) {
     var config = configArg;
     npmts_promisechain_1.npmtsOra.text("now looking at " + "required assets".yellow);
     if (config.cli == true) {
-        plugins.smartfile.fs.copy(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), paths.distDir);
+        plugins.smartfile.fs.copySync(plugins.path.join(paths.npmtsAssetsDir, "cli.js"), plugins.path.join(paths.distDir, "cli.js"));
         plugins.beautylog.ok("installed CLI assets!");
         done.resolve(config);
     }
     else {
+        plugins.beautylog.ok("No additional assets required!");
         done.resolve(config);
     }
     return done.promise;

dist/npmts.configfile.js

@@ -2,33 +2,34 @@
 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();
-    var config = {};
+    npmts_promisechain_1.npmtsOra.text("looking for npmextra.json");
-    var configPath = plugins.path.join(paths.cwd, "npmts.json");
+    var defaultConfig = {
+        mode: "default",
+        notest: false
+    };
     if (argvArg.notest) {
-        config.notest = true;
+        defaultConfig.notest = true;
-    }
-    if (plugins.smartfile.fs.fileExistsSync(configPath)) {
-        plugins.beautylog.info("npmts.json".blue + " config file found!");
-        config = plugins.lodashObject.assign(config, plugins.smartfile.fs.toObjectSync(configPath));
-        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);
-        }
-        ;
-    }
-    else {
-        plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
-        config.mode = "default";
-        done.resolve(config);
     }
     ;
+    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.plugins.d.ts

@@ -11,9 +11,8 @@ export declare let g: {
     sourcemaps: any;
     typedoc: any;
 };
-import "babel-preset-es2015";
 export declare let lodashObject: any;
-export declare let merge2: any;
+export import npmextra = require("npmextra");
 export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");

dist/npmts.plugins.js

@@ -12,9 +12,8 @@ exports.g = {
     sourcemaps: require("gulp-sourcemaps"),
     typedoc: require("gulp-typedoc")
 };
-require("babel-preset-es2015");
 exports.lodashObject = require('lodash/fp/object');
-exports.merge2 = require("merge2");
+exports.npmextra = require("npmextra");
 exports.projectinfo = require("projectinfo");
 exports.path = require("path");
 exports.Q = require("q");

dist/npmts.tests.js

@@ -14,19 +14,26 @@ var mocha = function (configArg) {
     var stream = plugins.gulp.src([plugins.path.join(paths.cwd, "dist/*.js")])
         .pipe(plugins.g.sourcemaps.init())
         .pipe(plugins.g.babel({
-        presets: ['es2015']
+        presets: [
+            require.resolve("babel-preset-es2015")
+        ]
     }))
-        .pipe(plugins.g.istanbul())
+        .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: ['es2015']
+            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())
+            .pipe(plugins.g.istanbul.writeReports({
+            dir: plugins.path.join(paths.cwd, "./coverage"),
+            reporters: ['lcovonly', 'json', 'text', 'text-summary']
+        }))
             .pipe(plugins.g.gFunction(function () {
             plugins.beautylog.ok("Tested!");
             done.resolve(configArg);

package.json

@@ -1,7 +1,7 @@
 {
   "name": "npmts",
-  "version": "5.3.16",
+  "version": "5.3.26",
-  "description": "write npm modules with TypeScript",
+  "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
   "main": "dist/index.js",
   "bin": {
     "npmts": "dist/cli.js"
@@ -29,9 +29,10 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmts#readme",
   "dependencies": {
-    "@types/minimatch": "*",
+    "@types/minimatch": "^2.0.28",
-    "@types/q": "*",
+    "@types/q": "^0.0.27",
-    "@types/shelljs": "*",
+    "@types/shelljs": "^0.3.27",
+    "babel-preset-es2015": "^6.9.0",
     "beautylog": "5.0.14",
     "early": "^2.0.13",
     "gulp": "3.9.1",
@@ -46,6 +47,7 @@
     "gulp-sourcemaps": "^1.6.0",
     "gulp-typedoc": "^2.0.0",
     "lodash": "^4.13.1",
+    "npmextra": "^1.0.8",
     "projectinfo": "1.0.3",
     "q": "^1.4.1",
     "shelljs": "^0.7.0",
@@ -53,9 +55,9 @@
     "smartcli": "1.0.4",
     "smartcov": "0.0.6",
     "smartenv": "1.2.5",
-    "smartfile": "4.0.10",
+    "smartfile": "4.0.12",
     "smartpath": "3.2.2",
-    "smartstring": "^2.0.14",
+    "smartstring": "^2.0.15",
     "source-map-support": "^0.4.2",
     "tsn": "^1.0.7",
     "typedoc": "^0.4.4",

ts/npmts.assets.ts

@@ -8,10 +8,14 @@ export var run = function(configArg){
     let config = configArg;
     npmtsOra.text("now looking at " + "required assets".yellow);
     if(config.cli == true){
-        plugins.smartfile.fs.copy(plugins.path.join(paths.npmtsAssetsDir,"cli.js"),paths.distDir);
+        plugins.smartfile.fs.copySync(
+            plugins.path.join(paths.npmtsAssetsDir,"cli.js"),
+            plugins.path.join(paths.distDir,"cli.js")
+        );
         plugins.beautylog.ok("installed CLI assets!");
         done.resolve(config);
     } else {
+        plugins.beautylog.ok("No additional assets required!")
         done.resolve(config);
     }
     return done.promise;

ts/npmts.configfile.ts

@@ -1,33 +1,32 @@
 import "typings-global";
 import plugins = require("./npmts.plugins");
 import paths = require("./npmts.paths");
+import {npmtsOra} from "./npmts.promisechain";
 export var run = function(argvArg){
-    var done = plugins.Q.defer();
+    let done = plugins.Q.defer();
-    var config:any = {};
+    npmtsOra.text("looking for npmextra.json");
-    var configPath = plugins.path.join(paths.cwd,"npmts.json");
+    let defaultConfig = {
-    if(argvArg.notest){
+        mode: "default",
-        config.notest = true;
+        notest:false
-    }
-    if(plugins.smartfile.fs.fileExistsSync(configPath)){
-        plugins.beautylog.info("npmts.json".blue + " config file found!");
-        config = plugins.lodashObject.assign(
-            config,
-            plugins.smartfile.fs.toObjectSync(configPath)
-        );
-        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);
-        };
-    } else {
-        plugins.beautylog.log("no config file found: so mode is " + "default".yellow);
-        config.mode = "default";
-        done.resolve(config);
     };
+    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.plugins.ts

@@ -11,9 +11,8 @@ export let g = {
     sourcemaps: require("gulp-sourcemaps"),
     typedoc: require("gulp-typedoc")
 };
-import "babel-preset-es2015";
 export let lodashObject = require('lodash/fp/object');
-export let merge2 = require("merge2");
+export import npmextra = require("npmextra");
 export import projectinfo = require("projectinfo");
 export import path = require("path");
 export import Q = require("q");

ts/npmts.tests.ts

@@ -14,19 +14,27 @@ let mocha = function (configArg) {
     var stream = plugins.gulp.src([plugins.path.join(paths.cwd,"dist/*.js")])
         .pipe(plugins.g.sourcemaps.init())
         .pipe(plugins.g.babel({
-            presets: ['es2015']
+            presets: [
+                require.resolve("babel-preset-es2015")
+            ]
+        }))
+        .pipe(plugins.g.istanbul({
         }))
-        .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: ['es2015']
+                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())
+            .pipe(plugins.g.istanbul.writeReports({
+                dir: plugins.path.join(paths.cwd,"./coverage"),
+                reporters: [ 'lcovonly', 'json', 'text', 'text-summary']
+            }))
             .pipe(plugins.g.gFunction(function(){
                 plugins.beautylog.ok("Tested!");
                 done.resolve(configArg);