8.0.3

See merge request !6

CHANGELOG

@@ -1,11 +0,0 @@
-Please view this file on the master branch, on stable branches it's out of date.
-
-v 6.0.0 (released)
-    - remove TypeDoc, please look at npmpage
-    - check package.json
-
-v 7.0.0
-    - switch from mocha to tap
-    - run tests in SubProcesses with coverage
-    - improve ES6 handling
-    - add smartanalytics

dist/mod00/mod00.check.d.ts

@@ -1,3 +1,4 @@
 import { ProjectinfoNpm } from 'projectinfo';
+import { INpmtsConfig } from '../npmts.config';
 export declare let projectInfo: ProjectinfoNpm;
-export declare let run: (configArg: any) => Promise<{}>;
+export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;

dist/mod00/mod00.check.js

@@ -1,4 +1,12 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const q = require("smartq");
 const projectinfo_1 = require("projectinfo");
@@ -107,23 +115,17 @@ let checkNodeVersion = (configArg) => {
     done.resolve(configArg);
     return done.promise;
 };
-exports.run = (configArg) => {
+exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
-    let done = q.defer();
     plugins.beautylog.ora.text('Check Module: ...');
-    // check cli
-    if (configArg.argv.nocheck) {
-        configArg.checkDependencies = false;
-    }
     if (configArg.checkDependencies) {
-        checkProjectTypings(configArg)
+        configArg = yield checkProjectTypings(configArg);
-            .then(checkDependencies)
+        configArg = yield checkDependencies(configArg);
-            .then(checkDevDependencies)
+        configArg = yield checkDevDependencies(configArg);
-            .then(checkNodeVersion)
+        configArg = yield checkNodeVersion(configArg);
-            .then(done.resolve)
+        return configArg;
-            .catch((err) => { console.log(err); });
     }
     else {
-        done.resolve(configArg);
+        configArg = yield checkProjectTypings(configArg);
+        return configArg;
     }
-    return done.promise;
+});
-};

dist/mod02/index.js

@@ -37,9 +37,6 @@ let tap = function (configArg) {
             experimentalDecorators: true,
             lib: ['DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable']
         }),
-        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()
@@ -110,7 +107,7 @@ exports.run = function (configArg) {
         plugins.beautylog.ora.text('now starting tests');
         plugins.beautylog.ora.end();
         plugins.beautylog.log('ready for tapbuffer:');
-        if (configArg.coverage) {
+        if (configArg.testConfig.coverage) {
             tap(config)
                 .then(handleCoverageData)
                 .then(() => {

dist/npmts.config.d.ts

@@ -1,3 +1,4 @@
+import { ITapbufferConfig } from 'tapbuffer';
 /**
  * specifies the different modes available
  * default -> uses default options no matterm what
@@ -7,13 +8,12 @@
 export declare type npmtsMode = 'default' | 'custom' | 'merge';
 export interface INpmtsConfig {
     argv: any;
-    coverage: boolean;
     coverageTreshold: number;
     checkDependencies: boolean;
     mode: npmtsMode;
     test: boolean;
     testTs: any;
-    testConfig: any;
+    testConfig: ITapbufferConfig;
     ts: any;
     tsOptions: any;
     watch: boolean;

dist/npmts.config.js

@@ -7,14 +7,14 @@ exports.run = function (argvArg) {
     let done = q.defer();
     let defaultConfig = {
         argv: undefined,
-        coverage: true,
         coverageTreshold: 70,
         checkDependencies: true,
         mode: 'default',
         test: true,
         testTs: {},
         testConfig: {
-            parallel: true
+            parallel: true,
+            coverage: true
         },
         ts: {},
         tsOptions: {},
@@ -53,7 +53,7 @@ exports.run = function (argvArg) {
         config.test = false;
     }
     if (config.argv.nocoverage) {
-        config.coverage = false;
+        config.testConfig.coverage = false;
     }
     if (config.argv.nochecks) {
         config.checkDependencies = false;

docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2017-07-30: Version 7.x.x -> 8.x.x
+Testfiles in ./test/ can now import files directly from the ts dir:
+
+```javascript
+// ./test/test.ts
+import * as myModule from '../ts/index
+```

docs/config.md

@@ -39,11 +39,12 @@ with default behaviour.
 
 | key | default value | description |
 | --- | --- | --- |
-| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify |
+| `"mode"` | `"default"` | "default" will do default stuff and override , "custom" only does what you specify, "merge" will merge default options with whatever you specify on your own |
 | `"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. |
+| `"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. |
+| `"testConfig"` | `{ parallel: true, coverage: true }` | allows you to control test behaviour. `"parallel"` controls wether testfiles are run sequentially or in parallel, and `"coverage` wether to create coverage reports |
 
 ### TypeScript
 by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to

docs/getstarted.md

@@ -0,0 +1,38 @@
+---
+name: Get Started
+description: learn how to quickly write npm TypeScript modules
+---
+# Get Started with NPMTS
+and learn how to quickly write npm TypeScript modules
+
+## Step1: Install the tools
+
+To use npmts install it using npm or yarn:
+
+```sh
+npm install -g npmts # install with npm
+yarn global add npmts # install with yarn
+```
+
+For the puspose of getting started quickly also install **gitzone**.
+It'll proovide awesome scaffolding for new npmts npm modules and also updates them later on. 
+
+```sh
+npm install -g gitzone # install with npm
+yarn global add gitzone # install with yarn
+```
+
+You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
+
+## Scaffold a new module
+
+To scaffold a new module type
+
+```shell
+gitzone template npm
+```
+
+This will run you through a series of question to get gitzone to know the specifics of your module.
+Enter all information accordingly.
+
+## Run NPMTS for the first time

docs/index.md

@@ -1,8 +1,9 @@
 ---
-name: Start
+name: Index
+description: best practice npm TypeScript modules
 ---
 # npmts
-Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
+best practice npm TypeScript modules
 
 ## Availabililty
 [![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "npmts",
-  "version": "7.1.6",
+  "version": "8.0.3",
-  "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
+  "description": "best practice npm TypeScript modules",
   "main": "dist/index.js",
   "bin": {
     "npmts": "assets/cliNpmts.js"
@@ -34,35 +34,35 @@
   },
   "homepage": "https://gitlab.com/gitzone/npmts#readme",
   "dependencies": {
-    "@types/gulp-sourcemaps": "0.0.30",
+    "@types/gulp-sourcemaps": "0.0.31",
     "@types/minimatch": "^2.0.29",
     "@types/through2": "^2.0.33",
-    "beautylog": "6.1.10",
+    "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.7",
+    "gulp-typescript": "^3.2.1",
     "lodash": "^4.17.4",
-    "npmextra": "^2.0.5",
+    "npmextra": "^2.0.8",
     "projectinfo": "^3.0.2",
     "smartanalytics": "^1.0.6",
-    "smartchok": "^1.0.8",
+    "smartchok": "^1.0.11",
     "smartcli": "^2.0.7",
     "smartcov": "^1.0.2",
     "smarterror": "^1.0.3",
     "smartfile": "^4.2.17",
     "smartgulp": "^1.0.6",
     "smartpath": "^3.2.8",
-    "smartq": "^1.1.1",
+    "smartq": "^1.1.6",
-    "smartstream": "^1.0.8",
+    "smartstream": "^1.0.10",
     "smartstring": "^2.0.24",
-    "smartsystem": "^1.0.17",
+    "smartsystem": "^1.0.18",
-    "tapbuffer": "^1.0.15",
+    "tapbuffer": "^1.0.29",
     "through2": "^2.0.3",
     "tsn": "^2.0.15",
-    "typescript": "^2.3.4",
+    "typescript": "^2.4.2",
-    "typings-global": "^1.0.17"
+    "typings-global": "^1.0.20"
   },
   "devDependencies": {}
 }

readme.md

@@ -1,5 +1,5 @@
 # npmts
-Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
+best practice npm TypeScript modules
 
 ## Availabililty
 [![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
@@ -33,9 +33,14 @@ npmts will
 
 For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
 
+For more information about how to best write tap tests check out the [tapbundle module's linked docs](https://www.npmjs.com/package/tapbundle).
+
 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/)
 
+## Changelog
+For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
+
 For further information read the linked docs at the top of this README.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

ts/mod00/mod00.check.ts

@@ -1,14 +1,17 @@
 import * as q from 'smartq'
 import { ProjectinfoNpm } from 'projectinfo'
 
+// interfaces
+import { INpmtsConfig } from '../npmts.config'
+
 import * as paths from '../npmts.paths'
 
 import * as plugins from './mod00.plugins'
 
 export let projectInfo: ProjectinfoNpm
 
-let checkProjectTypings = (configArg) => {
+let checkProjectTypings = (configArg: INpmtsConfig) => {
-  let done = q.defer()
+  let done = q.defer<INpmtsConfig>()
   plugins.beautylog.ora.text('Check Module: Check Project Typings...')
   projectInfo = new ProjectinfoNpm(paths.cwd)
   if (typeof projectInfo.packageJson.typings === 'undefined') {
@@ -34,8 +37,8 @@ const depcheckOptions = {
   ]
 }
 
-let checkDependencies = (configArg) => {
+let checkDependencies = (configArg: INpmtsConfig) => {
-  let done = q.defer()
+  let done = q.defer<INpmtsConfig>()
   plugins.beautylog.ora.text('Check Module: Check Dependencies...')
   let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
     ignoreDirs: [ // folder with these names will be ignored
@@ -70,8 +73,8 @@ let checkDependencies = (configArg) => {
   return done.promise
 }
 
-let checkDevDependencies = (configArg) => {
+let checkDevDependencies = (configArg: INpmtsConfig) => {
-  let done = q.defer()
+  let done = q.defer<INpmtsConfig>()
   plugins.beautylog.ora.text('Check Module: Check devDependencies...')
   let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
     ignoreDirs: [ // folder with these names will be ignored
@@ -106,31 +109,24 @@ let checkDevDependencies = (configArg) => {
   return done.promise
 }
 
-let checkNodeVersion = (configArg) => {
+let checkNodeVersion = (configArg: INpmtsConfig) => {
-  let done = q.defer()
+  let done = q.defer<INpmtsConfig>()
   plugins.beautylog.ora.text('checking node version')
   done.resolve(configArg)
   return done.promise
 }
 
-export let run = (configArg) => {
+export let run = async (configArg: INpmtsConfig) => {
-  let done = q.defer()
   plugins.beautylog.ora.text('Check Module: ...')
 
-  // check cli
-  if (configArg.argv.nocheck) {
-    configArg.checkDependencies = false
-  }
   if (configArg.checkDependencies) {
-    checkProjectTypings(configArg)
+    configArg = await checkProjectTypings(configArg)
-      .then(checkDependencies)
+    configArg = await checkDependencies(configArg)
-      .then(checkDevDependencies)
+    configArg = await checkDevDependencies(configArg)
-      .then(checkNodeVersion)
+    configArg = await checkNodeVersion(configArg)
-      .then(done.resolve)
+    return configArg
-      .catch((err) => { console.log(err) })
   } else {
-    done.resolve(configArg)
+    configArg = await checkProjectTypings(configArg)
+    return configArg
   }
-
-  return done.promise
 }

ts/mod02/index.ts

@@ -6,7 +6,9 @@ import paths = require('../npmts.paths')
 
 import * as q from 'smartq'
 
+// interfaces
 import { INpmtsConfig } from '../npmts.config'
+import { Smartfile } from 'smartfile'
 
 /**
  * runs mocha
@@ -34,9 +36,6 @@ let tap = function (configArg: INpmtsConfig) {
       experimentalDecorators: true,
       lib: [ 'DOM', 'ES5', 'ES2015.Promise', 'ES2015.Generator', 'ES2015.Iterable' ]
     }),
-    plugins.gulpFunction.forEach(async file => {
-      file.path = file.path.replace(paths.tsDir, paths.distDir)
-    }),
     plugins.gulpSourcemaps.write(),
     npmtsTapBuffer.pipeTestableFiles(),
     plugins.smartstream.cleanPipe()
@@ -116,7 +115,7 @@ 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) {
+    if (configArg.testConfig.coverage) {
       tap(config)
         .then(handleCoverageData)
         .then(() => {

ts/npmts.config.ts

@@ -3,6 +3,9 @@ import paths = require('./npmts.paths')
 
 import * as q from 'smartq'
 
+// interfaces
+import { ITapbufferConfig } from 'tapbuffer'
+
 /**
  * specifies the different modes available
  * default -> uses default options no matterm what
@@ -13,13 +16,12 @@ export type npmtsMode = 'default' | 'custom' | 'merge'
 
 export interface INpmtsConfig {
   argv: any
-  coverage: boolean
   coverageTreshold: number
   checkDependencies: boolean
   mode: npmtsMode
   test: boolean
   testTs: any
-  testConfig: any
+  testConfig: ITapbufferConfig
   ts: any
   tsOptions: any
   watch: boolean
@@ -33,14 +35,14 @@ 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: {},
     testConfig: {
-      parallel: true
+      parallel: true,
+      coverage: true
     },
     ts: {},
     tsOptions: {},
@@ -89,7 +91,7 @@ export let run = function (argvArg) {
   }
 
   if (config.argv.nocoverage) {
-    config.coverage = false
+    config.testConfig.coverage = false
   }
 
   if (config.argv.nochecks) {