9.0.2

See merge request !6

.gitignore

@@ -1,4 +1,20 @@
-.idea/
-.c9/
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
 node_modules/
-test/node_modules
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -0,0 +1,127 @@
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
+stages:
+  - security
+  - test
+  - release
+  - metadata
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+release:
+  stage: release
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

.npmignore

@@ -1,5 +0,0 @@
-support
-compile
-test
-examples
-.gitignore

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contribution Guide
+
+This module is developed on the fabulous GitLab.com:  
+https://gitlab.com/pushrocks/npmts

LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Push.Rocks
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

cli.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+process.env.CLI_CALL = 'true';
+const cliTool = require('./dist_ts/index');
+cliTool.runCli();

cli.ts.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+process.env.CLI_CALL = 'true';
+require('@gitzone/tsrun');
+const cliTool = require('./ts/index');
+cliTool.runCli();

compile/compile.js

@@ -1,25 +0,0 @@
-// import gulp
-var gulp = require("gulp");
-var gulpTypescript = require("gulp-typescript");
-var gulpInsert = require("gulp-insert");
-var plugins = {
-	beautylog: require("beautylog")
-};
-
-plugins.beautylog.log('now compiling the mojo.io gulp tasks');
-
-gulp.task('indexTS', function() {
-	var stream = gulp.src('../ts/index.ts')
-	  	.pipe(gulpTypescript({
-			out: "index.js"
-		}))
-		.pipe(gulpInsert.prepend('#!/usr/bin/env node\n\n'))
-	  	.pipe(gulp.dest("../"));
-	return stream;
-});
-
-gulp.task('default',['indexTS'], function() {
-	plugins.beautylog.success('Typescript compiled');
-});
-
-gulp.start.apply(gulp, ['default']);

dist/index.d.ts

@@ -0,0 +1 @@
+export {};

dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+/* ================================================== *
+    **** NPMTS ****
+    Fabulous TypeScript development
+ * ================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+const early = require("early");
+early.start('NPMTS');
+const plugins = require("./npmts.plugins");
+const cli = require("./npmts.cli");
+early.stop().then(() => {
+    let loaded = plugins; // to make sure plugins get actually loaded
+    cli.run();
+});

dist/mod_compile/index.d.ts

@@ -0,0 +1,2 @@
+import { INpmtsConfig } from '../npmts.config';
+export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;

dist/mod_compile/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* ------------------------------------------
+ * This module compiles the module's TypeScript files
+ * Note: Test files are only compiled in memory
+ * -------------------------------------------- */
+const q = require("smartq");
+const plugins = require("./mod.plugins");
+const NpmtsAssets = require("./mod.assets");
+const NpmtsCheck = require("./mod.check");
+const NpmtsClean = require("./mod.clean");
+const NpmtsCompile = require("./mod.compile");
+exports.run = function (configArg) {
+    let done = q.defer();
+    plugins.beautylog.ora.text('starting TypeScript Compilation');
+    NpmtsClean.run(configArg)
+        .then(NpmtsCheck.run)
+        .then(NpmtsCompile.run)
+        .then(NpmtsAssets.run)
+        .then(function () {
+        done.resolve(configArg);
+    });
+    return done.promise;
+};

dist/mod_compile/mod.assets.d.ts

@@ -0,0 +1 @@
+export declare let run: (configArg: any) => Promise<{}>;

dist/mod_compile/mod.assets.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const q = require("smartq");
+const paths = require("../npmts.paths");
+const plugins = require("./mod.plugins");
+const mod_check_1 = require("../mod_compile/mod.check");
+exports.run = function (configArg) {
+    let done = q.defer();
+    let config = configArg;
+    plugins.beautylog.ora.text('now looking at ' + 'required assets');
+    if (config.cli === true) {
+        let mainJsPath = mod_check_1.projectInfo.packageJson.main;
+        let cliJsString = plugins.smartfile.fs.toStringSync(plugins.path.join(paths.npmtsAssetsDir, 'cli.js'));
+        cliJsString = cliJsString.replace('{{pathToIndex}}', mainJsPath);
+        plugins.smartfile.memory.toFsSync(cliJsString, 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/mod_compile/mod.check.d.ts

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

dist/mod_compile/mod.check.js

@@ -0,0 +1,136 @@
+"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");
+const paths = require("../npmts.paths");
+const plugins = require("./mod.plugins");
+let checkProjectTypings = (configArg) => {
+    let done = q.defer();
+    plugins.beautylog.ora.text('Check Module: Check Project Typings...');
+    exports.projectInfo = new projectinfo_1.ProjectinfoNpm(paths.cwd);
+    if (typeof exports.projectInfo.packageJson.typings === 'undefined') {
+        plugins.beautylog.error(`please add typings field to package.json`);
+        process.exit(1);
+    }
+    done.resolve(configArg);
+    return done.promise;
+};
+const depcheckOptions = {
+    ignoreBinPackage: false,
+    parsers: {
+        // the target parsers
+        '*.ts': plugins.depcheck.parser.typescript
+    },
+    detectors: [
+        // the target detectors
+        plugins.depcheck.detector.requireCallExpression,
+        plugins.depcheck.detector.importDeclaration
+    ],
+    specials: [
+        // the target special parsers
+        plugins.depcheck.special.eslint,
+        plugins.depcheck.special.webpack
+    ]
+};
+let checkDependencies = (configArg) => {
+    let done = q.defer();
+    plugins.beautylog.ora.text('Check Module: Check Dependencies...');
+    let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
+        ignoreDirs: [
+            // folder with these names will be ignored
+            'test',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [
+            // ignore dependencies that matches these globs
+            '@types/*',
+            'babel-preset-*'
+        ]
+    });
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
+        for (let item of unused.dependencies) {
+            plugins.beautylog.warn(`Watch out: unused dependency "${item}"`);
+        }
+        for (let item in unused.missing) {
+            plugins.beautylog.error(`missing dependency "${item}" in package.json`);
+        }
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info('exiting due to missing dependencies in package.json');
+            process.exit(1);
+        }
+        for (let item in unused.invalidFiles) {
+            plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
+        }
+        for (let item in unused.invalidDirs) {
+            plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
+        }
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+let checkDevDependencies = (configArg) => {
+    let done = q.defer();
+    plugins.beautylog.ora.text('Check Module: Check devDependencies...');
+    let depcheckOptionsMerged = plugins.lodash.merge(depcheckOptions, {
+        ignoreDirs: [
+            // folder with these names will be ignored
+            'ts',
+            'dist',
+            'bower_components'
+        ],
+        ignoreMatches: [
+            // ignore dependencies that matches these globs
+            '@types/*',
+            'babel-preset-*'
+        ]
+    });
+    plugins.depcheck(paths.cwd, depcheckOptionsMerged, unused => {
+        for (let item of unused.devDependencies) {
+            plugins.beautylog.log(`unused devDependency ${item}`);
+        }
+        for (let item in unused.missing) {
+            plugins.beautylog.error(`missing devDependency ${item}`);
+        }
+        if (unused.missing.length > 0) {
+            plugins.beautylog.info('exiting due to missing dependencies in package.json');
+            process.exit(1);
+        }
+        for (let item in unused.invalidFiles) {
+            plugins.beautylog.warn(`Watch out: could not parse file ${item}`);
+        }
+        for (let item in unused.invalidDirs) {
+            plugins.beautylog.warn(`Watch out: could not parse directory ${item}`);
+        }
+        done.resolve(configArg);
+    });
+    return done.promise;
+};
+let checkNodeVersion = (configArg) => {
+    let done = q.defer();
+    plugins.beautylog.ora.text('checking node version');
+    done.resolve(configArg);
+    return done.promise;
+};
+exports.run = (configArg) => __awaiter(this, void 0, void 0, function* () {
+    plugins.beautylog.ora.text('Check Module: ...');
+    if (configArg.checkDependencies) {
+        configArg = yield checkProjectTypings(configArg);
+        configArg = yield checkDependencies(configArg);
+        configArg = yield checkDevDependencies(configArg);
+        configArg = yield checkNodeVersion(configArg);
+        return configArg;
+    }
+    else {
+        configArg = yield checkProjectTypings(configArg);
+        return configArg;
+    }
+});

dist/mod_compile/mod.clean.d.ts

@@ -0,0 +1 @@
+export declare let run: (configArg: any) => Promise<{}>;

dist/mod_compile/mod.clean.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const q = require("smartq");
+const paths = require("../npmts.paths");
+const plugins = require("./mod.plugins");
+/**
+ * removes the  dist directory which will be entirely rebuild
+ */
+let removeDist = function () {
+    plugins.beautylog.ora.text('cleaning dist folder');
+    return plugins.smartfile.fs.remove(paths.distDir);
+};
+/**
+ * remove old pages
+ */
+let removePages = function () {
+    plugins.beautylog.ora.text('cleaning pages folder');
+    return plugins.smartfile.fs.remove(paths.pagesDir);
+};
+exports.run = function (configArg) {
+    plugins.beautylog.ora.text('cleaning up from previous builds...');
+    let done = q.defer();
+    removeDist()
+        .then(removePages)
+        .then(function () {
+        plugins.beautylog.ok('Cleaned up from previous builds!');
+        done.resolve(configArg);
+    });
+    return done.promise;
+};

dist/mod_compile/mod.compile.d.ts

@@ -0,0 +1 @@
+export declare let run: (configArg: any) => Promise<{}>;

dist/mod_compile/mod.compile.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const q = require("smartq");
+const paths = require("../npmts.paths");
+const plugins = require("./mod.plugins");
+exports.run = function (configArg) {
+    let done = q.defer();
+    let config = configArg;
+    plugins.beautylog.ora.text('now compiling ' + 'TypeScript');
+    plugins.tsn
+        .compileGlobStringObject(config.ts, config.tsOptions, paths.cwd)
+        .then(() => {
+        plugins.beautylog.ok(`compiled the module's TypeScript!`);
+        done.resolve(config);
+    })
+        .catch(err => {
+        console.log(err);
+    });
+    return done.promise;
+};

dist/mod_compile/mod.plugins.d.ts

@@ -0,0 +1,5 @@
+export * from '../npmts.plugins';
+import * as tsn from 'tsn';
+import * as smartchok from 'smartchok';
+import * as smartstream from 'smartstream';
+export { tsn, smartchok, smartstream };

dist/mod_compile/mod.plugins.js

@@ -0,0 +1,12 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("../npmts.plugins"));
+const tsn = require("tsn");
+exports.tsn = tsn;
+const smartchok = require("smartchok");
+exports.smartchok = smartchok;
+const smartstream = require("smartstream");
+exports.smartstream = smartstream;

dist/mod_docs/index.d.ts

@@ -0,0 +1,2 @@
+import { INpmtsConfig } from '../npmts.config';
+export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;

dist/mod_docs/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* ------------------------------------------
+ * This module creates TypeScript documentation
+ * -------------------------------------------- */
+const q = require("smartq");
+exports.run = function (configArg) {
+    let done = q.defer();
+    done.resolve(configArg);
+    return done.promise;
+};

dist/mod_docs/mod.plugins.d.ts

@@ -0,0 +1 @@
+export * from '../npmts.plugins';

dist/mod_docs/mod.plugins.js

@@ -0,0 +1,6 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("../npmts.plugins"));

dist/mod_test/index.d.ts

@@ -0,0 +1,6 @@
+import { INpmtsConfig } from '../npmts.config';
+/**
+ * run this module
+ * @param configArg some config for how to run this module
+ */
+export declare let run: (configArg: INpmtsConfig) => Promise<INpmtsConfig>;

dist/mod_test/index.js

@@ -0,0 +1,132 @@
+"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 });
+/* ------------------------------------------
+ * This module tests the compiled TypeScript files
+ * -------------------------------------------- */
+const plugins = require("./mod.plugins");
+const paths = require("../npmts.paths");
+const q = require("smartq");
+let testTypeScriptConfig = {
+    target: 'ES5',
+    emitDecoratorMetadata: true,
+    experimentalDecorators: true,
+    lib: ['DOM', 'ESNext']
+};
+/**
+ * runs mocha
+ * @returns INpmtsConfig
+ */
+let tap = function (configArg) {
+    let done = q.defer();
+    /**
+     * the TabBuffer for npmts
+     */
+    let npmtsTapBuffer = new plugins.tapbuffer.TabBuffer();
+    npmtsTapBuffer.setConfig(configArg.testConfig);
+    /**
+     * handle the testable files
+     */
+    let testableFilesSmartstream = new plugins.smartstream.Smartstream([
+        plugins.smartgulp.src([plugins.path.join(paths.cwd, './ts/**/*.ts')]),
+        plugins.gulpSourcemaps.init(),
+        plugins.gulpTypeScript(testTypeScriptConfig),
+        plugins.gulpSourcemaps.write(),
+        npmtsTapBuffer.pipeTestableFiles(),
+        plugins.smartstream.cleanPipe()
+    ]);
+    /**
+     * handle the test files
+     */
+    let testFilesSmartstream = new plugins.smartstream.Smartstream([
+        plugins.smartgulp.src([plugins.path.join(paths.cwd, 'test/*.ts')]),
+        plugins.gulpSourcemaps.init(),
+        plugins.gulpTypeScript(testTypeScriptConfig),
+        plugins.gulpSourcemaps.write(),
+        npmtsTapBuffer.pipeTestFiles(),
+        plugins.smartstream.cleanPipe()
+    ]);
+    // lets run the smartstream
+    Promise.all([testableFilesSmartstream.run(), testFilesSmartstream.run()]).then(() => __awaiter(this, void 0, void 0, function* () {
+        configArg.runData.coverageLcovInfo = yield npmtsTapBuffer.runTests();
+        done.resolve(configArg);
+    }), err => {
+        plugins.beautylog.error('Tests failed!');
+        console.log(err);
+        if (configArg.watch) {
+            done.resolve(configArg);
+        }
+        else {
+            process.exit(1);
+        }
+    });
+    return done.promise;
+};
+let handleCoverageData = (configArg) => __awaiter(this, void 0, void 0, function* () {
+    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 ` +
+            `${configArg.coverageTreshold.toString()}%`);
+    }
+    else {
+        plugins.beautylog.warn(`${coverageResult.toString()}% ` +
+            `coverage fails your treshold of ` +
+            `${configArg.coverageTreshold.toString()}%`);
+        plugins.beautylog.error('exiting due to coverage failure');
+        if (!configArg.watch) {
+            process.exit(1);
+        }
+    }
+    return configArg;
+});
+/**
+ * run this module
+ * @param configArg some config for how to run this module
+ */
+exports.run = function (configArg) {
+    let done = q.defer();
+    let config = configArg;
+    if (config.test === true) {
+        plugins.beautylog.ora.text('now starting tests');
+        plugins.beautylog.ora.end();
+        plugins.beautylog.log('ready for tapbuffer:');
+        if (configArg.testConfig.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);
+    }
+    return done.promise;
+};

dist/mod_test/mod.plugins.d.ts

@@ -0,0 +1,8 @@
+export * from '../npmts.plugins';
+import * as gulpFunction from 'gulp-function';
+import * as gulpSourcemaps from 'gulp-sourcemaps';
+import * as gulpTypeScript from 'gulp-typescript';
+import * as smartcov from 'smartcov';
+import * as smartgulp from 'smartgulp';
+import * as tapbuffer from 'tapbuffer';
+export { gulpFunction, gulpSourcemaps, gulpTypeScript, smartcov, smartgulp, tapbuffer };

dist/mod_test/mod.plugins.js

@@ -0,0 +1,18 @@
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("../npmts.plugins"));
+const gulpFunction = require("gulp-function");
+exports.gulpFunction = gulpFunction;
+const gulpSourcemaps = require("gulp-sourcemaps");
+exports.gulpSourcemaps = gulpSourcemaps;
+const gulpTypeScript = require("gulp-typescript");
+exports.gulpTypeScript = gulpTypeScript;
+const smartcov = require("smartcov");
+exports.smartcov = smartcov;
+const smartgulp = require("smartgulp");
+exports.smartgulp = smartgulp;
+const tapbuffer = require("tapbuffer");
+exports.tapbuffer = tapbuffer;

dist/npmts.cli.d.ts

@@ -0,0 +1 @@
+export declare let run: () => Promise<{}>;

dist/npmts.cli.js

@@ -0,0 +1,109 @@
+"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 plugins = require("./npmts.plugins");
+const paths = require("./npmts.paths");
+const NpmtsConfig = require("./npmts.config");
+const NpmtsMods = require("./npmts.mods");
+const NpmtsWatch = require("./npmts.watch");
+const NpmtsShip = require("./npmts.ship");
+/**
+ * smartanalytics
+ * this data is fully anonymized (no Ips or any other personal information is tracked).
+ * It just keeps track which of our tools are really used...
+ * ... so we know where to spend our limited resources for improving them.
+ * Since yarn is out and there is heavy caching going on,
+ * pure download stats are just not reliable enough for us anymore
+ * Feel free to dig into the smartanalytics package, if you are interested in how it works.
+ * It is just an https call to our own Lossless Analytics API.
+ * Our privacy policy can be found here: https://lossless.gmbh/privacy.html
+ */
+let npmtsAnalytics = new plugins.smartanalytics.Analytics({
+    apiEndPoint: 'https://pubapi.lossless.one/analytics',
+    projectId: 'gitzone',
+    appName: 'npmts'
+});
+process.nextTick(() => __awaiter(this, void 0, void 0, function* () {
+    // make the analytics call
+    npmtsAnalytics
+        .recordEvent('npmToolExecution', {
+        executionMode: (yield NpmtsConfig.configPromise).mode,
+        tsOptions: (yield NpmtsConfig.configPromise).tsOptions,
+        watch: (yield NpmtsConfig.configPromise).watch,
+        coverageTreshold: (yield NpmtsConfig.configPromise).coverageTreshold
+    })
+        .catch(err => {
+        plugins.beautylog.warn('Lossless Analytics API not available...');
+    });
+}));
+exports.run = () => __awaiter(this, void 0, void 0, function* () {
+    let done = q.defer();
+    plugins.beautylog.figletSync('NPMTS');
+    let npmtsProjectInfo = new plugins.projectinfo.ProjectinfoNpm(paths.npmtsPackageRoot);
+    // check for updates
+    yield plugins.smartupdate.standardHandler.check('npmts', npmtsProjectInfo.version, 'http://gitzone.gitlab.io/npmts/changelog.html');
+    plugins.beautylog.log('---------------------------------------------');
+    let npmtsCli = new plugins.smartcli.Smartcli();
+    // build
+    npmtsCli
+        .addCommand('build')
+        .subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
+        let done = q.defer();
+        plugins.beautylog.info('npmts version: ' + npmtsProjectInfo.version);
+        const configArg = yield NpmtsConfig.run(argvArg);
+        plugins.beautylog.ora.start('loading additional modules...');
+        NpmtsMods.modCompile
+            .load()
+            .then(modCompile => {
+            return modCompile.run(configArg);
+        })
+            .then(configArg => {
+            let done = q.defer();
+            NpmtsMods.modDocs
+                .load()
+                .then(modDocs => {
+                return modDocs.run(configArg);
+            })
+                .then(configArg => {
+                done.resolve(configArg);
+            });
+            return done.promise;
+        })
+            .then(configArg => {
+            let done = q.defer();
+            NpmtsMods.modTest
+                .load()
+                .then(modTest => {
+                return modTest.run(configArg);
+            })
+                .then(configArg => {
+                done.resolve(configArg);
+            });
+            return done.promise;
+        })
+            .then(NpmtsWatch.run)
+            .then(NpmtsShip.run);
+        return done.promise;
+    }), err => {
+        if (err instanceof Error) {
+            console.log(err);
+        }
+    });
+    // standard task
+    npmtsCli.standardTask().subscribe((argvArg) => __awaiter(this, void 0, void 0, function* () {
+        yield npmtsCli.trigger('build');
+    }));
+    // cli metadata
+    npmtsCli.addVersion(npmtsProjectInfo.version);
+    // start parsing
+    npmtsCli.startParse();
+    return yield done.promise;
+});

dist/npmts.config.d.ts

@@ -0,0 +1,26 @@
+import { ITapbufferConfig } from 'tapbuffer';
+/**
+ * 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;
+    coverageTreshold: number;
+    checkDependencies: boolean;
+    mode: npmtsMode;
+    test: boolean;
+    testTs: any;
+    testConfig: ITapbufferConfig;
+    ts: any;
+    tsOptions: any;
+    watch: boolean;
+    runData: {
+        coverageLcovInfo?: string;
+        coverageResult?: number;
+    };
+}
+export declare let run: (argvArg: any) => Promise<INpmtsConfig>;
+export declare let configPromise: Promise<INpmtsConfig>;

dist/npmts.config.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const plugins = require("./npmts.plugins");
+const paths = require("./npmts.paths");
+const smartq = require("smartq");
+exports.run = function (argvArg) {
+    let done = smartq.defer();
+    let defaultConfig = {
+        argv: undefined,
+        coverageTreshold: 70,
+        checkDependencies: true,
+        mode: 'default',
+        test: true,
+        testTs: {},
+        testConfig: {
+            parallel: true,
+            coverage: true
+        },
+        ts: {},
+        tsOptions: {},
+        watch: false,
+        runData: {}
+    };
+    // mix with configfile
+    plugins.beautylog.ora.text('running npmextra');
+    let localNpmextra = new plugins.npmextra.Npmextra(paths.cwd);
+    let config = localNpmextra.dataFor('npmts', defaultConfig);
+    // add argv
+    config.argv = argvArg;
+    // check mode
+    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! Can be default or custom`);
+            process.exit(1);
+    }
+    // handle default mode
+    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.testConfig.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);
+    configDeferred.resolve(config);
+    return done.promise;
+};
+// config deferred usage
+let configDeferred = smartq.defer();
+exports.configPromise = configDeferred.promise;

dist/npmts.mods.d.ts

@@ -0,0 +1,7 @@
+import * as plugins from './npmts.plugins';
+import * as _modCompile from './mod_compile/index';
+import * as _modDocs from './mod_docs/index';
+import * as _modTest from './mod_test/index';
+export declare let modCompile: plugins.smartsystem.LazyModule<typeof _modCompile>;
+export declare let modDocs: plugins.smartsystem.LazyModule<typeof _modDocs>;
+export declare let modTest: plugins.smartsystem.LazyModule<typeof _modTest>;

dist/npmts.mods.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const smartsystem_1 = require("smartsystem");
+exports.modCompile = new smartsystem_1.LazyModule('./mod_compile/index', __dirname);
+exports.modDocs = new smartsystem_1.LazyModule('./mod_docs/index', __dirname);
+exports.modTest = new smartsystem_1.LazyModule('./mod_test/index', __dirname);

dist/npmts.paths.d.ts

@@ -0,0 +1,12 @@
+export declare let npmtsPackageRoot: string;
+export declare let cwd: string;
+export declare let tsDir: string;
+export declare let distDir: string;
+export declare let testDir: string;
+export declare let typingsDir: string;
+export declare let coverageDir: string;
+export declare let pagesDir: string;
+export declare let pagesApiDir: string;
+export declare let npmtsAssetsDir: string;
+export declare let indexTS: string;
+export declare let testTS: string;

dist/npmts.paths.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const plugins = require("./npmts.plugins");
+// NPMTS Paths
+exports.npmtsPackageRoot = plugins.path.join(__dirname, '../');
+// Project paths
+exports.cwd = process.cwd();
+// Directories
+exports.tsDir = plugins.path.join(exports.cwd, 'ts/');
+exports.distDir = plugins.path.join(exports.cwd, 'dist/');
+exports.testDir = plugins.path.join(exports.cwd, 'test/');
+exports.typingsDir = plugins.path.join(exports.cwd, 'ts/typings/');
+exports.coverageDir = plugins.path.join(exports.cwd, 'coverage/');
+// Pages
+exports.pagesDir = plugins.path.join(exports.cwd, 'pages/');
+exports.pagesApiDir = plugins.path.join(exports.pagesDir, '/api');
+exports.npmtsAssetsDir = plugins.path.join(__dirname, '../assets/');
+// Files
+exports.indexTS = plugins.path.join(exports.cwd, 'ts/index.ts');
+exports.testTS = plugins.path.join(exports.cwd, 'ts/test.ts');

dist/npmts.plugins.d.ts

@@ -0,0 +1,17 @@
+import * as beautylog from 'beautylog';
+declare let depcheck: any;
+import * as lodash from 'lodash';
+import * as npmextra from 'npmextra';
+import * as projectinfo from 'projectinfo';
+import * as path from 'path';
+import * as smartanalytics from 'smartanalytics';
+import * as smartcli from '@pushrocks/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 smartupdate from 'smartupdate';
+import * as through2 from 'through2';
+export { beautylog, depcheck, lodash, npmextra, projectinfo, path, smartanalytics, smartcli, smarterror, smartfile, smartpath, smartstream, smartstring, smartsystem, smartupdate, through2 };

dist/npmts.plugins.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const beautylog = require("beautylog");
+exports.beautylog = beautylog;
+let depcheck = require('depcheck');
+exports.depcheck = depcheck;
+const lodash = require("lodash");
+exports.lodash = lodash;
+const npmextra = require("npmextra");
+exports.npmextra = npmextra;
+const projectinfo = require("projectinfo");
+exports.projectinfo = projectinfo;
+const path = require("path");
+exports.path = path;
+const smartanalytics = require("smartanalytics");
+exports.smartanalytics = smartanalytics;
+const smartcli = require("@pushrocks/smartcli");
+exports.smartcli = smartcli;
+const smarterror = require("smarterror");
+exports.smarterror = smarterror;
+const smartfile = require("smartfile");
+exports.smartfile = smartfile;
+const smartpath = require("smartpath");
+exports.smartpath = smartpath;
+const smartstream = require("smartstream");
+exports.smartstream = smartstream;
+const smartstring = require("smartstring");
+exports.smartstring = smartstring;
+const smartsystem = require("smartsystem");
+exports.smartsystem = smartsystem;
+const smartupdate = require("smartupdate");
+exports.smartupdate = smartupdate;
+const through2 = require("through2");
+exports.through2 = through2;

dist/npmts.ship.d.ts

@@ -0,0 +1,2 @@
+import { INpmtsConfig } from './npmts.config';
+export declare let run: (configArg: INpmtsConfig) => void;

dist/npmts.ship.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const q = require("smartq");
+const plugins = require("./npmts.plugins");
+exports.run = (configArg) => {
+    let done = q.defer();
+    let shipString = '' +
+        '\n' +
+        '\n' +
+        '                                         # #  ( )\n' +
+        '                                      ___#_#___|__\n' +
+        '                                  _  |____________|  _\n' +
+        '                           _=====| | |            | | |==== _\n' +
+        '                     =====| |.---------------------------. | |====\n' +
+        "       <--------------------'   .  .  .  .  .  .  .  .   '--------------/\n" +
+        '         \\                                                             /\n' +
+        '          \\___________________________________________________________/\n' +
+        '    wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
+        '   wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n' +
+        '     wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww\n';
+    if (process.env.CI) {
+        console.log(shipString);
+        plugins.beautylog.success('READY TO SHIP!');
+    }
+    else {
+        plugins.beautylog.success('Done!');
+    }
+    done.resolve(configArg);
+};

dist/npmts.watch.d.ts

@@ -0,0 +1,2 @@
+import { INpmtsConfig } from './npmts.config';
+export declare let run: (configArg: INpmtsConfig) => Promise<{}>;

dist/npmts.watch.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const q = require("smartq");
+const smartchok = require("smartchok");
+const plugins = require("./npmts.plugins");
+const cli = require("./npmts.cli");
+let npmtsSmartchok = null;
+exports.run = (configArg) => {
+    let done = q.defer();
+    if (configArg.watch && npmtsSmartchok === null) {
+        let pathsToWatch = [];
+        for (let key in configArg.ts) {
+            pathsToWatch.push(key);
+        }
+        for (let key in configArg.testTs) {
+            pathsToWatch.push(key);
+        }
+        npmtsSmartchok = new smartchok.Smartchok(pathsToWatch);
+        npmtsSmartchok.getObservableFor('change').then(changeObservableArg => {
+            plugins.beautylog.info('now watching...');
+            changeObservableArg.subscribe(() => {
+                cli.run();
+            });
+        });
+        npmtsSmartchok.start();
+        done.resolve(configArg);
+    }
+    else {
+        plugins.beautylog.info('not watching');
+        done.resolve(configArg);
+    }
+    return done.promise;
+};

docs/00footer.md

@@ -0,0 +1,9 @@
+[Legal Info](https://lossless.gmbh)
+[Privacy Policy](https://lossless.gmbh/privacy.html)
+///
+[Git.Zone](https://git.zone)
+<span>tools for a seamless dev workflow</span>
+
+[Lossless GmbH](https://push.rocks)
+<span>the company behind git.zone and npmts</span>
+///

docs/changelog.md

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,88 @@
+---
+name: config
+---
+
+# Configuration
+
+npmts can be configured to your needs.
+
+### npmextra.json
+
+the npmts section in npmextra.json can be used to configure npmts.
+
+**Default**
+
+> Note: When you are using `"mode":"default"` it'll cause npmts to override any other settings you may have made except for tsOptions (ES target etc.)
+> with default behaviour.
+
+```json
+{
+  "npmts": {
+    "mode": "default"
+  }
+}
+```
+
+**Custom settings**
+
+```json
+{
+  "mode": "custom",
+  "test": true,
+  "npmts": {
+    "ts": {
+      "./customdir/*.ts": "./"
+    },
+    "tsOptions": {
+      "declaration": false,
+      "target": "ES6"
+    },
+    "cli": true
+  }
+}
+```
+
+| key            | default value                                   | description                                                                                                                                                         |
+| -------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `"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.                                  |
+| `"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
+`./dist/*.js` and `./test/test.js`
+
+Use commonjs module system for wiring up files.
+
+### Declaration files
+
+**npmts** also creates declaration files like `./dist/index.d.ts` by default.
+You can reference it in your package.json like this.
+
+```json
+"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.
+
+## Some notes:
+
+#### Typings for third party modules that do not bundle declaration files
+
+NPMTS 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.
+
+#### Tests
+
+Any errors will be shown with reference to their originating source in TypeScript
+thanks to autogenerated source maps.

docs/default.md

@@ -0,0 +1,13 @@
+---
+name: Default Behaviour
+---
+
+# Default Behaviour
+
+when you don't configure it otherwise.
+
+1.  **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra))
+1.  **Clean:** Clean up from any previous builds (old js files)
+1.  **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies
+1.  **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target
+1.  **Test:** transpile TypeScript of module to ES5 for tests (so it can be instrumentalized) and pipe it to tapbuffer. All this happens in memory.

docs/examples.md

@@ -0,0 +1,23 @@
+---
+name: Examples
+---
+
+# Examples
+
+modules that use npmts in theis development workflow
+
+| Module Name                                                | Description                 |
+| ---------------------------------------------------------- | --------------------------- |
+| [gitzone](https://www.npmjs.com/package/gitzone)           | fast npm module prototyping |
+| [gulp-browser](https://www.npmjs.com/package/gulp-browser) | browserify for gulp         |
+| [npmdocker](https://www.npmjs.com/package/npmdocker)       | dockerized npm development  |
+| [smartcli](https://www.npmjs.com/package/smartcli)         | easy cli tool creation      |
+
+> There are tons more... We will add them here 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/npmpage) to create a webpage from coverage reports and TypeDoc for the module
+- Use [hosttoday/ht-docker-node:npmci](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.

docs/getstarted.md

@@ -0,0 +1,40 @@
+---
+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 purpose of getting started quickly please also install **gitzone**.
+It'll proovide awesome scaffolding for new npmts maintained 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

@@ -0,0 +1,52 @@
+---
+name: Index
+description: best practice npm TypeScript modules
+---
+
+# npmts
+
+best practice npm TypeScript modules
+
+## Availabililty
+
+[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
+[![git](https://gitzone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/gitzone/npmts)
+[![git](https://gitzone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/gitzone/npmts)
+[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/npmts/)
+
+## Status for master
+
+[![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/gitzonetools/npmts.svg)](https://david-dm.org/gitzonetools/npmts)
+[![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/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.
+
+npmts will
+
+1.  check your dependencies and package.json (unused, missing, updates, security)
+1.  transpile your code with tsc,
+1.  test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
+1.  create coverage with istanbul (supports tracing of the originating TypeScript)
+
+For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
+
+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/)
+
+> 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)

docs/install.md

@@ -0,0 +1,19 @@
+# Install npmts
+
+Get started with TypeScript awesomeness.
+
+> \*_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
+npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency
+```
+
+Then add it to your package.json's script section to trigger a build:
+
+```json
+"scripts": {
+    "test": "(npmts)"
+}
+```

docs/structure.md

@@ -0,0 +1,27 @@
+---
+name: npmts project structure
+description: how npmts projects are structured
+---
+
+# npmts - Project Structure
+
+**locally**
+
+```text
+projectroot
+|- .nogit/           # contains files that should not be checked into git - NOgit
+|- dist/             # contains compiled js files and their corresponding typings - git
+|- node_modules/     # contains the installed node modules - NOgit
+|- test/             # contains the test files - git
+|- ts/               # contains the source TypeScript files - git
+|
+|- .gitignore        # the normal gitignore file
+|- .gitlab-ci.yml    # the gitlab ci yml file
+|- npmextra.json     # npmextra.json
+|- package.json      # the standard npm module package.json file
+|- readme.md         # the standard project readme
+|- tslint.json       # the standard tslint.json for TypeScript
+|- yarn.lock         # yarn.lock - the standard yarn.lock file
+```
+
+**in git**

index.js

@@ -1,32 +0,0 @@
-#!/usr/bin/env node
-
-/// <reference path="./typings/tsd.d.ts" />
-var plugins = {
-    beautylog: require("beautylog"),
-    gulp: require("gulp"),
-    gulpTypeScript: require("gulp-typescript"),
-    path: require("path"),
-    smartcli: require("smartcli")
-};
-var paths = {};
-paths.cwd = plugins.smartcli.get.cwd().path;
-paths.indexTS = plugins.path.join(paths.cwd, "ts/index.ts");
-paths.testTS = plugins.path.join(paths.cwd, "ts/test.ts");
-plugins.gulp.task("indexTS", function () {
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-        out: "index.js"
-    }))
-        .pipe(plugins.gulp.dest(paths.cwd));
-});
-plugins.gulp.task("indexTS", function () {
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-        out: "test.js"
-    }))
-        .pipe(plugins.gulp.dest(paths.cwd));
-});
-plugins.gulp.task("default", ["indexTS"], function () {
-    plugins.beautylog.success("TypeScript for this module was compiled successfully.");
-});
-plugins.gulp.start.apply(plugins.gulp, ['default']);

license

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Push.Rocks
+Copyright (c) 2016 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

npmextra.json

@@ -0,0 +1,16 @@
+{
+  "npmci": {
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "gitzone",
+      "gitrepo": "tscoverage",
+      "shortDescription": "get coverage information for gitzone projects",
+      "npmPackagename": "@gitzone/tscoverage",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,35 +1,52 @@
 {
-  "name": "npmts",
-  "version": "0.0.6",
-  "description": "write npm modules with TypeScript",
-  "main": "index.js",
+  "name": "@gitzone/tscoverage",
+  "version": "9.0.2",
+  "description": "get coverage information for gitzone projects",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "bin": {
-    "npmts": "index.js"
+    "tscoverage": "cli.js"
   },
   "scripts": {
-    "test": "(cd compile && node compile.js)",
-    "release": "(git add -A && git commit -m 'update' && git push origin master && npm version patch && npm publish)",
-    "testm": "(cd test/ && npm update && npm test)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pushrocks/npmts.git"
+    "url": "git+https://gitlab.com/gitzone/npmts.git"
   },
   "keywords": [
     "TypeScript",
     "Declaration"
   ],
-  "author": "Lossless Digital UG (haftungsbeschraenkt)",
+  "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/npmts/issues"
+    "url": "https://gitlab.com/gitzone/npmts/issues"
   },
-  "homepage": "https://github.com/pushrocks/npmts#readme",
-  "dependencies": {
-    "beautylog": "^2.0.2",
-    "gulp": "^3.9.0",
-    "gulp-insert": "^0.5.0",
-    "gulp-typescript": "^2.10.0",
-    "smartcli": "0.0.11"
-  }
+  "homepage": "https://gitlab.com/gitzone/npmts#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbundle": "^1.0.69",
+    "@gitzone/tstest": "^1.0.33",
+    "@gitzone/tswatch": "^1.0.46",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^10.0.3",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "private": true,
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,39 @@
+# @gitzone/tscoverage
+get coverage information for gitzone projects
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tscoverage)
+* [gitlab.com (source)](https://gitlab.com/gitzone/tscoverage)
+* [github.com (source mirror)](https://github.com/gitzone/tscoverage)
+* [docs (typedoc)](https://gitzone.gitlab.io/tscoverage/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tscoverage/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tscoverage/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@gitzone/tscoverage)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/gitzone/tscoverage)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@gitzone/tscoverage)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@gitzone/tscoverage)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@gitzone/tscoverage)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+tscoverage will run tests while computing coverage for your gitzone project.
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/node_modules/npmts/package.json

@@ -1,42 +0,0 @@
-{
-  "name": "npmts",
-  "version": "0.0.5",
-  "description": "write npm modules with TypeScript",
-  "main": "index.js",
-  "bin": {
-    "npmts": "index.js"
-  },
-  "scripts": {
-    "test": "(cd compile && node compile.js)",
-    "testm": "(cd test/ && npm update && npm test)"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/pushrocks/npmts.git"
-  },
-  "keywords": [
-    "TypeScript",
-    "Declaration"
-  ],
-  "author": {
-    "name": "Lossless Digital UG",
-    "url": "haftungsbeschraenkt"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/pushrocks/npmts/issues"
-  },
-  "homepage": "https://github.com/pushrocks/npmts#readme",
-  "dependencies": {
-    "beautylog": "^2.0.2",
-    "gulp": "^3.9.0",
-    "gulp-insert": "^0.5.0",
-    "gulp-typescript": "^2.10.0",
-    "smartcli": "0.0.11"
-  },
-  "gitHead": "39b7fe99c7ba1d5299c4a7d61f1dad52ee0fb561",
-  "readme": "ERROR: No README data found!",
-  "_id": "npmts@0.0.5",
-  "_shasum": "f38b99c06a047aec650770b891c588b1cec03db0",
-  "_from": "npmts@0.0.5"
-}

test/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "test",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "(npmts)"
-  },
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "npmts": "*"
-  }
-}

test/test.ts

@@ -0,0 +1,7 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+tap.test('should run a test', async () => {
+  console.log('hi there');
+});
+
+tap.start();

test/ts/index.js

@@ -1,4 +0,0 @@
-(function () {
-    console.log("test");
-}());
-//# sourceMappingURL=index.js.map

test/ts/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,CAAC;IACG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AACvB,CAAC,EAAE,CAAC,CAAC"}

test/ts/index.ts

@@ -1,3 +0,0 @@
-(function(){
-    console.log("test")
-}());

ts/index.js

@@ -1,31 +0,0 @@
-/// <reference path="./typings/tsd.d.ts" />
-var plugins = {
-    beautylog: require("beautylog"),
-    gulp: require("gulp"),
-    gulpTypeScript: require("gulp-typescript"),
-    path: require("path"),
-    smartcli: require("smartcli")
-};
-var paths = {};
-paths.cwd = plugins.smartcli.get.cwd().path;
-paths.indexTS = plugins.path.join(paths.cwd, "ts/index.ts");
-paths.testTS = plugins.path.join(paths.cwd, "ts/test.ts");
-plugins.gulp.task("indexTS", function () {
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-        out: "index.js"
-    }))
-        .pipe(plugins.gulp.dest(paths.cwd));
-});
-plugins.gulp.task("indexTS", function () {
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-        out: "test.js"
-    }))
-        .pipe(plugins.gulp.dest(paths.cwd));
-});
-plugins.gulp.task("default", ["indexTS"], function () {
-    plugins.beautylog.success("TypeScript for this module was compiled successfully.");
-});
-plugins.gulp.start.apply(plugins.gulp, ['default']);
-//# sourceMappingURL=index.js.map

ts/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,IAAI,OAAO,GAAG;IACV,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC;IAC/B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAC1C,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC;CAChC,CAAC;AAEF,IAAI,KAAK,GAAO,EAAE,CAAC;AACnB,KAAK,CAAC,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;AAC5C,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAC,aAAa,CAAC,CAAC;AAC3D,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAC,YAAY,CAAC,CAAC;AAEzD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;IACzB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC;SAC1B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;QACzB,GAAG,EAAE,UAAU;KAClB,CAAC,CAAC;SACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AAC3C,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;IACzB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC;SAC1B,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;QACzB,GAAG,EAAE,SAAS;KACjB,CAAC,CAAC;SACF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;AAC3C,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAC,CAAC,SAAS,CAAC,EAAC;IACrC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;AACtF,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC"}

ts/index.ts

@@ -1,35 +1 @@
-/// <reference path="./typings/tsd.d.ts" />
-var plugins = {
-    beautylog: require("beautylog"),
-    gulp: require("gulp"),
-    gulpTypeScript: require("gulp-typescript"),
-    path: require("path"),
-    smartcli: require("smartcli")
-};
-
-var paths:any = {};
-paths.cwd = plugins.smartcli.get.cwd().path;
-paths.indexTS = plugins.path.join(paths.cwd,"ts/index.ts");
-paths.testTS = plugins.path.join(paths.cwd,"ts/test.ts");
-
-plugins.gulp.task("indexTS", function(){
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-            out: "index.js"
-        }))
-        .pipe(plugins.gulp.dest(paths.cwd))
-});
-
-plugins.gulp.task("indexTS", function(){
-    plugins.gulp.src(paths.indexTS)
-        .pipe(plugins.gulpTypeScript({
-            out: "test.js"
-        }))
-        .pipe(plugins.gulp.dest(paths.cwd))
-});
-
-plugins.gulp.task("default",["indexTS"],function(){
-   plugins.beautylog.success("TypeScript for this module was compiled successfully.");
-});
-
-plugins.gulp.start.apply(plugins.gulp, ['default']);
+console.log('tscoverage');

ts/tsd.json

@@ -1,18 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
-    },
-    "colors/colors.d.ts": {
-      "commit": "09e37435ffb2c56a6f908081194a74756f24f99d"
-    },
-    "vinyl/vinyl.d.ts": {
-      "commit": "78d36dd49b6b55b9fdfe61776a12bf05c8b07777"
-    }
-  }
-}

ts/typings/colors/colors.d.ts

@@ -1,123 +0,0 @@
-// Type definitions for Colors.js 0.6.0-1
-// Project: https://github.com/Marak/colors.js
-// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-declare module "colors" {
-    interface Color {
-        (text: string): string;
-
-        black: Color;
-        red: Color;
-        green: Color;
-        yellow: Color;
-        blue: Color;
-        magenta: Color;
-        cyan: Color;
-        white: Color;
-        gray: Color;
-        grey: Color;
-
-        bgBlack: Color;
-        bgRed: Color;
-        bgGreen: Color;
-        bgYellow: Color;
-        bgBlue: Color;
-        bgMagenta: Color;
-        bgCyan: Color;
-        bgWhite: Color;
-
-        reset: Color;
-        bold: Color;
-        dim: Color;
-        italic: Color;
-        underline: Color;
-        inverse: Color;
-        hidden: Color;
-        strikethrough: Color;
-
-        rainbow: Color;
-        zebra: Color;
-        america: Color;
-        trap: Color;
-        random: Color;
-    }
-
-    module e {
-        export function setTheme(theme:any): void;
-
-        export var black: Color;
-        export var red: Color;
-        export var green: Color;
-        export var yellow: Color;
-        export var blue: Color;
-        export var magenta: Color;
-        export var cyan: Color;
-        export var white: Color;
-        export var gray: Color;
-        export var grey: Color;
-
-        export var bgBlack: Color;
-        export var bgRed: Color;
-        export var bgGreen: Color;
-        export var bgYellow: Color;
-        export var bgBlue: Color;
-        export var bgMagenta: Color;
-        export var bgCyan: Color;
-        export var bgWhite: Color;
-
-        export var reset: Color;
-        export var bold: Color;
-        export var dim: Color;
-        export var italic: Color;
-        export var underline: Color;
-        export var inverse: Color;
-        export var hidden: Color;
-        export var strikethrough: Color;
-
-        export var rainbow: Color;
-        export var zebra: Color;
-        export var america: Color;
-        export var trap: Color;
-        export var random: Color;
-    }
-
-    export = e;
-}
-
-interface String {
-    black: string;
-    red: string;
-    green: string;
-    yellow: string;
-    blue: string;
-    magenta: string;
-    cyan: string;
-    white: string;
-    gray: string;
-    grey: string;
-
-    bgBlack: string;
-    bgRed: string;
-    bgGreen: string;
-    bgYellow: string;
-    bgBlue: string;
-    bgMagenta: string;
-    bgCyan: string;
-    bgWhite: string;
-
-    reset: string;
-    bold: string;
-    dim: string;
-    italic: string;
-    underline: string;
-    inverse: string;
-    hidden: string;
-    strikethrough: string;
-
-    rainbow: string;
-    zebra: string;
-    america: string;
-    trap: string;
-    random: string;
-}

ts/typings/tsd.d.ts

@@ -1,3 +0,0 @@
-/// <reference path="node/node.d.ts" />
-/// <reference path="colors/colors.d.ts" />
-/// <reference path="vinyl/vinyl.d.ts" />

ts/typings/vinyl/vinyl.d.ts

@@ -1,109 +0,0 @@
-// Type definitions for vinyl 0.4.3
-// Project: https://github.com/wearefractal/vinyl
-// Definitions by: vvakame <https://github.com/vvakame/>, jedmao <https://github.com/jedmao>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-/// <reference path="../node/node.d.ts" />
-
-declare module 'vinyl' {
-
-	import fs = require('fs');
-
-	/**
-	* A virtual file format.
-	*/
-	class File {
-		constructor(options?: {
-			/**
-			* Default: process.cwd()
-			*/
-			cwd?: string;
-			/**
-			* Used for relative pathing. Typically where a glob starts.
-			*/
-			base?: string;
-			/**
-			* Full path to the file.
-			*/
-			path?: string;
-			/**
-			* Path history. Has no effect if options.path is passed.
-			*/
-			history?: string[];
-			/**
-			* The result of an fs.stat call. See fs.Stats for more information.
-			*/
-			stat?: fs.Stats;
-			/**
-			* File contents.
-			* Type: Buffer, Stream, or null
-			*/
-			contents?: Buffer | NodeJS.ReadWriteStream;
-		});
-
-		/**
-		* Default: process.cwd()
-		*/
-		public cwd: string;
-		/**
-		* Used for relative pathing. Typically where a glob starts.
-		*/
-		public base: string;
-		/**
-		* Full path to the file.
-		*/
-		public path: string;
-		public stat: fs.Stats;
-		/**
-		* Type: Buffer|Stream|null (Default: null)
-		*/
-		public contents: Buffer | NodeJS.ReadableStream;
-		/**
-		* Returns path.relative for the file base and file path.
-		* Example:
-		*  var file = new File({
-		*    cwd: "/",
-		*    base: "/test/",
-		*    path: "/test/file.js"
-		*  });
-		*  console.log(file.relative); // file.js
-		*/
-		public relative: string;
-
-		public isBuffer(): boolean;
-
-		public isStream(): boolean;
-
-		public isNull(): boolean;
-
-		public isDirectory(): boolean;
-
-		/**
-		* Returns a new File object with all attributes cloned. Custom attributes are deep-cloned.
-		*/
-		public clone(opts?: { contents?: boolean }): File;
-
-		/**
-		* If file.contents is a Buffer, it will write it to the stream.
-		* If file.contents is a Stream, it will pipe it to the stream.
-		* If file.contents is null, it will do nothing.
-		*/
-		public pipe<T extends NodeJS.ReadWriteStream>(
-			stream: T,
-			opts?: {
-				/**
-				* If false, the destination stream will not be ended (same as node core).
-				*/
-				end?: boolean;
-			}
-		): T;
-
-		/**
-		* Returns a pretty String interpretation of the File. Useful for console.log.
-		*/
-		public inspect(): string;
-	}
-
-	export = File;
-
-}

tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "module": "commonjs",
+        "target": "ES6",
+        "outDir": "./dist/"
+    },
+    "exclude": [
+        "./node_modules",
+        "./test",
+        "./dist"
+    ]
+}

tslint.json

@@ -0,0 +1,17 @@
+{
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
+}