7.1.4

introduce a merge option

See merge request !5

dist/mod00/mod00.check.js

@@ -85,7 +85,7 @@ let checkDevDependencies = (configArg) => {
             plugins.beautylog.log(`unused devDependency ${item}`);
         }
         for (let item in unused.missing) {
-            plugins.beautylog.error(`unused devDependency ${item}`);
+            plugins.beautylog.error(`missing devDependency ${item}`);
         }
         if (unused.missing.length > 0) {
             plugins.beautylog.info('exiting due to missing dependencies in package.json');
@@ -110,11 +110,20 @@ let checkNodeVersion = (configArg) => {
 exports.run = (configArg) => {
     let done = q.defer();
     plugins.beautylog.ora.text('Check Module: ...');
+    // check cli
+    if (configArg.argv.nocheck) {
+        configArg.checkDependencies = false;
+    }
+    if (configArg.checkDependencies) {
         checkProjectTypings(configArg)
             .then(checkDependencies)
             .then(checkDevDependencies)
             .then(checkNodeVersion)
             .then(done.resolve)
             .catch((err) => { console.log(err); });
+    }
+    else {
+        done.resolve(configArg);
+    }
     return done.promise;
 };

dist/mod00/mod00.clean.js

@@ -10,17 +10,6 @@ let removeDist = function () {
     plugins.beautylog.ora.text('cleaning dist folder');
     return plugins.smartfile.fs.remove(paths.distDir);
 };
-/**
- * remove .d.ts files from testDirctory
- */
-let removeTestDeclarations = function () {
-    let done = q.defer();
-    plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
-        let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/');
-        plugins.smartfile.fs.removeManySync(fileArrayToRemove);
-        done.resolve();
-    });
-};
 /**
  * remove old pages
  */
@@ -32,7 +21,6 @@ exports.run = function (configArg) {
     plugins.beautylog.ora.text('cleaning up from previous builds...');
     let done = q.defer();
     removeDist()
-        .then(removeTestDeclarations)
         .then(removePages)
         .then(function () {
         plugins.beautylog.ok('Cleaned up from previous builds!');

dist/mod02/index.js

@@ -36,10 +36,10 @@ let tap = function (configArg) {
             experimentalDecorators: true,
             lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
         }),
-        plugins.gulpSourcemaps.write(),
         plugins.gulpFunction.forEach((file) => __awaiter(this, void 0, void 0, function* () {
             file.path = file.path.replace(paths.tsDir, paths.distDir);
         })),
+        plugins.gulpSourcemaps.write(),
         npmtsTapBuffer.pipeTestableFiles(),
         plugins.smartstream.cleanPipe()
     ]);
@@ -48,12 +48,14 @@ let tap = function (configArg) {
      */
     let testFilesSmartstream = new plugins.smartstream.Smartstream([
         plugins.smartgulp.src([plugins.path.join(paths.cwd, 'test/*.ts')]),
+        plugins.gulpSourcemaps.init(),
         plugins.gulpTypeScript({
             target: 'ES5',
             emitDecoratorMetadata: true,
             experimentalDecorators: true,
             lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
         }),
+        plugins.gulpSourcemaps.write(),
         npmtsTapBuffer.pipeTestFiles(),
         plugins.smartstream.cleanPipe()
     ]);
@@ -77,7 +79,13 @@ let tap = function (configArg) {
     return done.promise;
 };
 let handleCoverageData = (configArg) => __awaiter(this, void 0, void 0, function* () {
-    let coverageResult = yield plugins.smartcov.get.percentageFromLcovString(configArg.runData.coverageLcovInfo, 2);
+    let coverageResult = 0; // the coverage in percent
+    if (configArg.runData.coverageLcovInfo) {
+        coverageResult = yield plugins.smartcov.get.percentageFromLcovString(configArg.runData.coverageLcovInfo, 2);
+    }
+    else {
+        plugins.beautylog.warn('Hey... Did your tests import and use your module that you are trying to test?');
+    }
     if (coverageResult >= configArg.coverageTreshold) {
         plugins.beautylog.ok(`${(coverageResult).toString()}% `
             + `coverage exceeds your treshold of `
@@ -101,12 +109,20 @@ exports.run = function (configArg) {
         plugins.beautylog.ora.text('now starting tests');
         plugins.beautylog.ora.end();
         plugins.beautylog.log('ready for tapbuffer:');
+        if (configArg.coverage) {
             tap(config)
                 .then(handleCoverageData)
                 .then(() => {
                 done.resolve(config);
             }).catch(err => { console.log(err); });
         }
+        else {
+            tap(config)
+                .then(() => {
+                done.resolve(config);
+            }).catch(err => { console.log(err); });
+        }
+    }
     else {
         plugins.beautylog.ora.end();
         done.resolve(config);

dist/npmts.config.d.ts

@@ -1,7 +1,15 @@
-export declare type npmtsMode = 'default' | 'custom';
+/**
+ * specifies the different modes available
+ * default -> uses default options no matterm what
+ * merge -> uses merged default + custom options
+ * custom -> only uses specified options
+ */
+export declare type npmtsMode = 'default' | 'custom' | 'merge';
 export interface INpmtsConfig {
     argv: any;
+    coverage: boolean;
     coverageTreshold: number;
+    checkDependencies: boolean;
     mode: npmtsMode;
     test: boolean;
     testTs: any;

dist/npmts.config.js

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const plugins = require("./npmts.plugins");
 const paths = require("./npmts.paths");
 const q = require("smartq");
-;
 exports.run = function (argvArg) {
     let done = q.defer();
     let defaultConfig = {
         argv: undefined,
+        coverage: true,
         coverageTreshold: 70,
+        checkDependencies: true,
         mode: 'default',
         test: true,
         testTs: {},
@@ -27,16 +28,16 @@ exports.run = function (argvArg) {
     switch (config.mode) {
         case 'default':
         case 'custom':
+        case 'merge':
             plugins.beautylog.ok('mode is ' + config.mode);
             done.resolve(config);
             break;
         default:
-            plugins.beautylog.error(`mode not recognised!`);
+            plugins.beautylog.error(`mode not recognised! Can be default or custom`);
             process.exit(1);
     }
-    ;
     // handle default mode
-    if (config.mode === 'default') {
+    if (config.mode === 'default' || config.mode === 'merge') {
         config.ts = {
             './ts/**/*.ts': './dist/'
         };
@@ -44,16 +45,19 @@ exports.run = function (argvArg) {
             './test/**/*.ts': './test/'
         };
     }
-    ;
     // mix with commandline
     if (config.argv.notest) {
         config.test = false;
     }
-    ;
+    if (config.argv.nocoverage) {
+        config.coverage = false;
+    }
+    if (config.argv.nochecks) {
+        config.checkDependencies = false;
+    }
     if (config.argv.watch) {
         config.watch = true;
     }
-    ;
     plugins.beautylog.ok('build options are ready!');
     done.resolve(config);
     return done.promise;

dist/npmts.plugins.d.ts

@@ -7,11 +7,11 @@ import * as projectinfo from 'projectinfo';
 import * as path from 'path';
 import * as smartanalytics from 'smartanalytics';
 import * as smartcli from 'smartcli';
+import * as smarterror from 'smarterror';
 import * as smartfile from 'smartfile';
 import * as smartpath from 'smartpath';
 import * as smartstream from 'smartstream';
 import * as smartstring from 'smartstring';
 import * as smartsystem from 'smartsystem';
 import * as through2 from 'through2';
-export declare let sourceMapSupport: any;
+export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, through2 };
-export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smartfile, smartpath, smartstream, smartstring, smartsystem, through2 };

dist/npmts.plugins.js

@@ -17,6 +17,8 @@ const smartanalytics = require("smartanalytics");
 exports.smartanalytics = smartanalytics;
 const smartcli = require("smartcli");
 exports.smartcli = smartcli;
+const smarterror = require("smarterror");
+exports.smarterror = smarterror;
 const smartfile = require("smartfile");
 exports.smartfile = smartfile;
 const smartpath = require("smartpath");
@@ -29,4 +31,3 @@ const smartsystem = require("smartsystem");
 exports.smartsystem = smartsystem;
 const through2 = require("through2");
 exports.through2 = through2;
-exports.sourceMapSupport = require('source-map-support').install(); // display errors correctly during testing

docs/index.md

@@ -14,13 +14,16 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
 [![build status](https://GitLab.com/gitzone/npmts/badges/master/build.svg)](https://GitLab.com/gitzone/npmts/commits/master)
 [![coverage report](https://GitLab.com/gitzone/npmts/badges/master/coverage.svg)](https://GitLab.com/gitzone/npmts/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/npmts.svg)](https://www.npmjs.com/package/npmts)
-[![Dependency Status](https://david-dm.org/gitzone/npmts.svg)](https://david-dm.org/gitzone/npmts)
+[![Dependency Status](https://david-dm.org/gitzonetools/npmts.svg)](https://david-dm.org/gitzonetools/npmts)
-[![bitHound Dependencies](https://www.bithound.io/github/gitzone/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzone/npmts/master/dependencies/npm)
+[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/gitzone/npmts/badges/code.svg)](https://www.bithound.io/github/gitzone/npmts)
+[![bitHound Code](https://www.bithound.io/github/gitzonetools/npmts/badges/code.svg)](https://www.bithound.io/github/gitzonetools/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/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
+## Quick Demo
+[![asciicast](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze.png)](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
+
 ## Usage
 NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "7.0.16",
+  "version": "7.1.4",
   "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
   "main": "dist/index.js",
   "bin": {
@@ -36,32 +36,32 @@
   "dependencies": {
     "@types/gulp-sourcemaps": "0.0.30",
     "@types/minimatch": "^2.0.29",
-    "@types/through2": "^2.0.32",
+    "@types/through2": "^2.0.33",
     "beautylog": "6.1.10",
     "depcheck": "^0.6.7",
     "early": "^2.1.1",
     "gulp-function": "^2.2.9",
     "gulp-sourcemaps": "^2.6.0",
-    "gulp-typescript": "^3.1.6",
+    "gulp-typescript": "^3.1.7",
     "lodash": "^4.17.4",
     "npmextra": "^2.0.5",
     "projectinfo": "^3.0.2",
     "smartanalytics": "^1.0.6",
     "smartchok": "^1.0.8",
-    "smartcli": "^2.0.6",
+    "smartcli": "^2.0.7",
     "smartcov": "^1.0.2",
-    "smartfile": "^4.2.7",
+    "smarterror": "^1.0.3",
-    "smartgulp": "^1.0.5",
+    "smartfile": "^4.2.17",
+    "smartgulp": "^1.0.6",
     "smartpath": "^3.2.8",
     "smartq": "^1.1.1",
     "smartstream": "^1.0.8",
     "smartstring": "^2.0.24",
-    "smartsystem": "^1.0.12",
+    "smartsystem": "^1.0.17",
-    "source-map-support": "^0.4.15",
+    "tapbuffer": "^1.0.13",
-    "tapbuffer": "^1.0.11",
     "through2": "^2.0.3",
     "tsn": "^2.0.15",
-    "typescript": "^2.3.2",
+    "typescript": "^2.3.4",
     "typings-global": "^1.0.16"
   },
   "devDependencies": {}

readme.md

@@ -11,13 +11,16 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
 [![build status](https://GitLab.com/gitzone/npmts/badges/master/build.svg)](https://GitLab.com/gitzone/npmts/commits/master)
 [![coverage report](https://GitLab.com/gitzone/npmts/badges/master/coverage.svg)](https://GitLab.com/gitzone/npmts/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/npmts.svg)](https://www.npmjs.com/package/npmts)
-[![Dependency Status](https://david-dm.org/gitzone/npmts.svg)](https://david-dm.org/gitzone/npmts)
+[![Dependency Status](https://david-dm.org/gitzonetools/npmts.svg)](https://david-dm.org/gitzonetools/npmts)
-[![bitHound Dependencies](https://www.bithound.io/github/gitzone/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzone/npmts/master/dependencies/npm)
+[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/gitzone/npmts/badges/code.svg)](https://www.bithound.io/github/gitzone/npmts)
+[![bitHound Code](https://www.bithound.io/github/gitzonetools/npmts/badges/code.svg)](https://www.bithound.io/github/gitzonetools/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/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
+## Quick Demo
+[![asciicast](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze.png)](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
+
 ## Usage
 NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
 
@@ -33,7 +36,9 @@ For more information on how tests are run check out the [tapbuffer module](https
 This works on your machine and in CI. There is a prebuild 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/)
 
+For further information read the linked docs at the top of this README.
+
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://git.zone)
+[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

ts/mod00/mod00.check.ts

@@ -89,7 +89,7 @@ let checkDevDependencies = (configArg) => {
       plugins.beautylog.log(`unused devDependency ${item}`)
     }
     for (let item in unused.missing) {
-            plugins.beautylog.error(`unused devDependency ${item}`)
+      plugins.beautylog.error(`missing devDependency ${item}`)
     }
     if (unused.missing.length > 0) {
       plugins.beautylog.info('exiting due to missing dependencies in package.json')
@@ -116,11 +116,21 @@ let checkNodeVersion = (configArg) => {
 export let run = (configArg) => {
   let done = q.defer()
   plugins.beautylog.ora.text('Check Module: ...')
+
+  // check cli
+  if (configArg.argv.nocheck) {
+    configArg.checkDependencies = false
+  }
+  if (configArg.checkDependencies) {
     checkProjectTypings(configArg)
       .then(checkDependencies)
       .then(checkDevDependencies)
       .then(checkNodeVersion)
       .then(done.resolve)
       .catch((err) => { console.log(err) })
+  } else {
+    done.resolve(configArg)
+  }
+
   return done.promise
 }

ts/mod00/mod00.clean.ts

@@ -11,18 +11,6 @@ let removeDist = function () {
   return plugins.smartfile.fs.remove(paths.distDir)
 }
 
-/**
- * remove .d.ts files from testDirctory
- */
-let removeTestDeclarations = function () {
-    let done = q.defer()
-    plugins.smartfile.fs.listFileTree('./test/', '**/*.d.ts').then(fileArray => {
-        let fileArrayToRemove = plugins.smartpath.transform.toAbsolute(fileArray, process.cwd() + '//test/')
-        plugins.smartfile.fs.removeManySync(fileArrayToRemove)
-        done.resolve()
-    })
-}
-
 /**
  * remove old pages
  */
@@ -35,7 +23,6 @@ export let run = function (configArg) {
   plugins.beautylog.ora.text('cleaning up from previous builds...')
   let done = q.defer()
   removeDist()
-        .then(removeTestDeclarations)
     .then(removePages)
     .then(function () {
       plugins.beautylog.ok('Cleaned up from previous builds!')

ts/mod02/index.ts

@@ -32,10 +32,10 @@ let tap = function (configArg: INpmtsConfig) {
       experimentalDecorators: true,
       lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
     }),
-    plugins.gulpSourcemaps.write(),
     plugins.gulpFunction.forEach(async file => {
       file.path = file.path.replace(paths.tsDir, paths.distDir)
     }),
+    plugins.gulpSourcemaps.write(),
     npmtsTapBuffer.pipeTestableFiles(),
     plugins.smartstream.cleanPipe()
   ])
@@ -45,12 +45,14 @@ let tap = function (configArg: INpmtsConfig) {
    */
   let testFilesSmartstream = new plugins.smartstream.Smartstream([
     plugins.smartgulp.src([ plugins.path.join(paths.cwd, 'test/*.ts') ]),
+    plugins.gulpSourcemaps.init(),
     plugins.gulpTypeScript({
       target: 'ES5',
       emitDecoratorMetadata: true,
       experimentalDecorators: true,
       lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
     }),
+    plugins.gulpSourcemaps.write(),
     npmtsTapBuffer.pipeTestFiles(),
     plugins.smartstream.cleanPipe()
   ])
@@ -77,10 +79,16 @@ let tap = function (configArg: INpmtsConfig) {
 }
 
 let handleCoverageData = async (configArg: INpmtsConfig) => {
-  let coverageResult = await plugins.smartcov.get.percentageFromLcovString(
+  let coverageResult: number = 0 // the coverage in percent
+  if (configArg.runData.coverageLcovInfo) {
+    coverageResult = await plugins.smartcov.get.percentageFromLcovString(
       configArg.runData.coverageLcovInfo,
       2
     )
+  } else {
+    plugins.beautylog.warn('Hey... Did your tests import and use your module that you are trying to test?')
+  }
+
   if (coverageResult >= configArg.coverageTreshold) {
     plugins.beautylog.ok(
       `${(coverageResult).toString()}% `
@@ -106,12 +114,19 @@ export let run = function (configArg: INpmtsConfig) {
     plugins.beautylog.ora.text('now starting tests')
     plugins.beautylog.ora.end()
     plugins.beautylog.log('ready for tapbuffer:')
-
+    if (configArg.coverage) {
       tap(config)
         .then(handleCoverageData)
         .then(() => {
           done.resolve(config)
         }).catch(err => { console.log(err) })
+    } else {
+      tap(config)
+        .then(() => {
+          done.resolve(config)
+        }).catch(err => { console.log(err) })
+    }
+
   } else {
     plugins.beautylog.ora.end()
     done.resolve(config)

ts/npmts.config.ts

@@ -3,28 +3,38 @@ import paths = require('./npmts.paths')
 
 import * as q from 'smartq'
 
-export type npmtsMode = 'default' | 'custom'
+/**
+ * specifies the different modes available
+ * default -> uses default options no matterm what
+ * merge -> uses merged default + custom options
+ * custom -> only uses specified options
+ */
+export type npmtsMode = 'default' | 'custom' | 'merge'
 
 export interface INpmtsConfig {
-  argv: any,
+  argv: any
-  coverageTreshold: number,
+  coverage: boolean
-  mode: npmtsMode,
+  coverageTreshold: number
-  test: boolean,
+  checkDependencies: boolean
-  testTs: any,
+  mode: npmtsMode
-  ts: any,
+  test: boolean
-  tsOptions: any,
+  testTs: any
+  ts: any
+  tsOptions: any
   watch: boolean
   runData: {
-    coverageLcovInfo?: string,
+    coverageLcovInfo?: string
     coverageResult?: number
   }
-};
+}
 
 export let run = function (argvArg) {
   let done = q.defer()
   let defaultConfig: INpmtsConfig = {
     argv: undefined,
+    coverage: true,
     coverageTreshold: 70,
+    checkDependencies: true,
     mode: 'default',
     test: true,
     testTs: {},
@@ -50,31 +60,41 @@ export let run = function (argvArg) {
   switch (config.mode) {
     case 'default':
     case 'custom':
+    case 'merge':
       plugins.beautylog.ok('mode is ' + config.mode)
       done.resolve(config)
       break
     default:
-      plugins.beautylog.error(`mode not recognised!`)
+      plugins.beautylog.error(`mode not recognised! Can be default or custom`)
       process.exit(1)
-  };
+  }
 
   // handle default mode
-  if (config.mode === 'default') {
+  if (config.mode === 'default' || config.mode === 'merge') {
     config.ts = {
       './ts/**/*.ts': './dist/'
     }
     config.testTs = {
       './test/**/*.ts': './test/'
     }
-  };
+  }
 
   // mix with commandline
   if (config.argv.notest) {
     config.test = false
-  };
+  }
+
+  if (config.argv.nocoverage) {
+    config.coverage = false
+  }
+
+  if (config.argv.nochecks) {
+    config.checkDependencies = false
+  }
+
   if (config.argv.watch) {
     config.watch = true
-  };
+  }
 
   plugins.beautylog.ok('build options are ready!')
   done.resolve(config)

ts/npmts.plugins.ts

@@ -8,13 +8,13 @@ import * as projectinfo from 'projectinfo'
 import * as path from 'path'
 import * as smartanalytics from 'smartanalytics'
 import * as smartcli from 'smartcli'
+import * as smarterror from 'smarterror'
 import * as smartfile from 'smartfile'
 import * as smartpath from 'smartpath'
 import * as smartstream from 'smartstream'
 import * as smartstring from 'smartstring'
 import * as smartsystem from 'smartsystem'
 import * as through2 from 'through2'
-export let sourceMapSupport = require('source-map-support').install() // display errors correctly during testing
 
 export {
     beautylog,
@@ -25,6 +25,7 @@ export {
     path,
     smartanalytics,
     smartcli,
+    smarterror,
     smartfile,
     smartpath,
     smartstream,