3.0.8

.gitignore

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

.gitlab-ci.yml

@@ -1,48 +1,137 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
+  - security
-- release
+  - test
-- page
+  - release
+  - metadata
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+    - npmci git mirror
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
 
-testLTS:
+auditDevDependencies:
+  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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-    - npmci test stable
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
 
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  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:
-  image: hosttoday/ht-docker-node:npmpage
+  stage: metadata
-  stage: page
   script:
-    - npmci command npmpage --host gitlab
+    - 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
+      - public
+  allow_failure: true

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.12.0
+ignore: {}
+patch: {}

.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", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,47 +0,0 @@
-# npmextra
-do more with npm.
-
-npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
-
-## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmextra)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmextra)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmextra)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmextra/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/npmextra/badges/master/build.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/npmextra/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/npmextra.svg)](https://david-dm.org/pushrocks/npmextra)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmextra/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmextra/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/npmextra/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmextra)
-[![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/)
-
-## Usage
-The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.
-
-npmextra.json
-```json
-{
-    "sometool": {
-        "defaultKey1": "awesomeValueFromConfig"
-    }
-}
-```
-
-```typescript
-import * as npmextra from 'npmextra'
-
-npmextra.dataFor({
-    toolName:'sometool',
-    defaultSettings: { // gets merged with whatever is in the configfile
-        defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
-        defaultKey2: 'defaultValue2' // this one will pass through unaltered
-    },
-    cwd?: string // lets you specifiy a custom current working directory to look for the npmextra.json
-})
-```
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './npmextra.classes.npmextra';
-export * from './npmextra.classes.keyvaluestore';

dist/index.js

@@ -1,7 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-__export(require("./npmextra.classes.npmextra"));
-__export(require("./npmextra.classes.keyvaluestore"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaURBQTJDO0FBQzNDLHNEQUFnRCJ9

dist/npmextra.classes.keyValueStore.d.ts

@@ -1,6 +0,0 @@
-export declare type keyValueStoreTypes = 'path' | 'gitProject';
-export declare class KeyValueStore {
-    constructor(optionsArg: {
-        type: keyValueStoreTypes;
-    });
-}

dist/npmextra.classes.keyValueStore.js

@@ -1,22 +0,0 @@
-"use strict";
-class KeyValueStore {
-    constructor(optionsArg) {
-    }
-}
-exports.KeyValueStore = KeyValueStore;
-/**
-* reads a keyValueFile from disk
-*/
-let kvRead = () => {
-};
-/**
- * writes a key value file to disk
- */
-let kvWrite = () => {
-};
-/**
- * wipes a key value store from disk
- */
-let kevWipe = () => {
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFNQTtJQUNJLFlBQVksVUFFWDtJQUVELENBQUM7Q0FBQTtBQUxMLHNDQUtLO0FBQ0Q7O0VBRUQ7QUFDSCxJQUFJLE1BQU0sR0FBQztBQUVYLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ0gsSUFBSSxPQUFPLEdBQUM7QUFFWixDQUFDLENBQUE7QUFFRDs7R0FFRztBQUNILElBQUksT0FBTyxHQUFDO0FBRVosQ0FBQyxDQUFBIn0=

dist/npmextra.classes.npmextra.d.ts

@@ -1,29 +0,0 @@
-/**
- * Npmextra class allows easy configuration of tools
- */
-export declare class Npmextra {
-    cwd: string;
-    lookupPath: string;
-    npmextraJsonExists: boolean;
-    npmextraJsonData: boolean;
-    /**
-     * creates instance of Npmextra
-     */
-    constructor(cwdArg?: string);
-    /**
-     * merges the supplied options with the ones from npmextra.json
-     */
-    dataFor(toolnameArg: string, defaultOptionsArg: any): any;
-    /**
-     * checks if the JSON exists
-     */
-    private checkNpmextraJsonExists();
-    /**
-     * gets lookupPath
-     */
-    private checkLookupPath();
-    /**
-     * get npmextraJsonData
-     */
-    private checkNpmextraJsonData();
-}

dist/npmextra.classes.npmextra.js

@@ -1,64 +0,0 @@
-"use strict";
-const plugins = require("./npmextra.plugins");
-const paths = require("./npmextra.paths");
-/**
- * Npmextra class allows easy configuration of tools
- */
-class Npmextra {
-    /**
-     * creates instance of Npmextra
-     */
-    constructor(cwdArg) {
-        if (cwdArg) {
-            this.cwd = cwdArg;
-        }
-        else {
-            this.cwd = paths.cwd;
-        }
-        this.checkLookupPath();
-        this.checkNpmextraJsonExists();
-        this.checkNpmextraJsonData();
-    }
-    /**
-     * merges the supplied options with the ones from npmextra.json
-     */
-    dataFor(toolnameArg, defaultOptionsArg) {
-        let npmextraToolOptions;
-        if (this.npmextraJsonData[toolnameArg]) {
-            npmextraToolOptions = this.npmextraJsonData[toolnameArg];
-        }
-        else {
-            npmextraToolOptions = {};
-        }
-        let mergedOptions = plugins.lodash.merge({}, defaultOptionsArg, npmextraToolOptions);
-        return mergedOptions;
-    }
-    /**
-     * checks if the JSON exists
-     */
-    checkNpmextraJsonExists() {
-        this.npmextraJsonExists = plugins.smartfile.fs.fileExistsSync(this.lookupPath);
-    }
-    /**
-     * gets lookupPath
-     */
-    checkLookupPath() {
-        if (this.cwd) {
-            this.lookupPath = plugins.path.join(this.cwd, 'npmextra.json');
-        }
-        else {
-            this.lookupPath = paths.configFile;
-        }
-        ;
-    }
-    /**
-     * get npmextraJsonData
-     */
-    checkNpmextraJsonData() {
-        if (this.npmextraJsonExists) {
-            this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath);
-        }
-    }
-}
-exports.Npmextra = Npmextra;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5ucG1leHRyYS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLmNsYXNzZXMubnBtZXh0cmEudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDhDQUE2QztBQUM3QywwQ0FBeUM7QUFFekM7O0dBRUc7QUFDSDtJQU1JOztPQUVHO0lBQ0gsWUFBWSxNQUFlO1FBQ3ZCLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDVCxJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQTtRQUNyQixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixJQUFJLENBQUMsR0FBRyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUE7UUFDeEIsQ0FBQztRQUNELElBQUksQ0FBQyxlQUFlLEVBQUUsQ0FBQTtRQUN0QixJQUFJLENBQUMsdUJBQXVCLEVBQUUsQ0FBQTtRQUM5QixJQUFJLENBQUMscUJBQXFCLEVBQUUsQ0FBQTtJQUNoQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPLENBQUMsV0FBbUIsRUFBRSxpQkFBc0I7UUFDL0MsSUFBSSxtQkFBbUIsQ0FBQTtRQUN2QixFQUFFLENBQUEsQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ3BDLG1CQUFtQixHQUFHLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUM1RCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixtQkFBbUIsR0FBRyxFQUFFLENBQUE7UUFDNUIsQ0FBQztRQUNELElBQUksYUFBYSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsRUFBRSxpQkFBaUIsRUFBRSxtQkFBbUIsQ0FBQyxDQUFBO1FBQ3BGLE1BQU0sQ0FBQyxhQUFhLENBQUE7SUFDeEIsQ0FBQztJQUVEOztPQUVHO0lBQ0ssdUJBQXVCO1FBQzNCLElBQUksQ0FBQyxrQkFBa0IsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFBO0lBQ2xGLENBQUM7SUFFRDs7T0FFRztJQUNLLGVBQWU7UUFDbkIsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDWCxJQUFJLENBQUMsVUFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsZUFBZSxDQUFDLENBQUE7UUFDbEUsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osSUFBSSxDQUFDLFVBQVUsR0FBRyxLQUFLLENBQUMsVUFBVSxDQUFBO1FBQ3RDLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQztJQUVEOztPQUVHO0lBQ0sscUJBQXFCO1FBQ3pCLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDLENBQUM7WUFDMUIsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDOUUsQ0FBQztJQUNMLENBQUM7Q0FFSjtBQTdERCw0QkE2REMifQ==

dist/npmextra.paths.d.ts

@@ -1,3 +0,0 @@
-export declare let cwd: string;
-export declare let packageDir: string;
-export declare let configFile: string;

dist/npmextra.paths.js

@@ -1,8 +0,0 @@
-"use strict";
-const plugins = require("./npmextra.plugins");
-// directories
-exports.cwd = process.cwd();
-exports.packageDir = plugins.path.join(__dirname, '../');
-// files
-exports.configFile = plugins.path.join(exports.cwd, 'npmextra.json');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsOENBQTZDO0FBRTdDLGNBQWM7QUFDSCxRQUFBLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7QUFDbkIsUUFBQSxVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLEtBQUssQ0FBQyxDQUFBO0FBRTFELFFBQVE7QUFDRyxRQUFBLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFHLEVBQUMsZUFBZSxDQUFDLENBQUEifQ==

dist/npmextra.plugins.d.ts

@@ -1,6 +0,0 @@
-import 'typings-global';
-export import beautylog = require('beautylog');
-export import lodash = require('lodash');
-export import path = require('path');
-export import smartfile = require('smartfile');
-export import q = require('q');

dist/npmextra.plugins.js

@@ -1,8 +0,0 @@
-"use strict";
-require("typings-global");
-exports.beautylog = require("beautylog");
-exports.lodash = require("lodash");
-exports.path = require("path");
-exports.smartfile = require("smartfile");
-exports.q = require("q");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2Qix5Q0FBOEM7QUFDOUMsbUNBQXdDO0FBQ3hDLCtCQUFvQztBQUNwQyx5Q0FBOEM7QUFDOUMseUJBQThCIn0=

npmextra.json

@@ -0,0 +1,22 @@
+{
+  "npmci": {
+    "globalNpmTools": [],
+    "npmAccessLevel": "public"
+  },
+  "npmts": {
+    "testConfig": {
+      "parallel": false
+    }
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "npmextra",
+      "shortDescription": "do more with npm",
+      "npmPackagename": "@pushrocks/npmextra",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "npmextra",
+  "name": "@pushrocks/npmextra",
-  "version": "2.0.0",
+  "version": "3.0.8",
+  "private": false,
   "description": "do more with npm",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -18,16 +20,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@types/q": "^0.x.x",
+    "@pushrocks/smartfile": "^8.0.8",
-    "beautylog": "^5.0.23",
+    "@pushrocks/smartlog": "^2.0.39",
-    "lodash": "^4.16.1",
+    "@pushrocks/smartpath": "^4.0.3",
-    "q": "^1.4.1",
+    "@pushrocks/smartpromise": "^3.1.3",
-    "smartfile": "^4.0.20",
+    "@pushrocks/taskbuffer": "^2.1.13"
-    "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@gitzone/tsbuild": "^2.1.25",
-    "should": "^11.1.0",
+    "@gitzone/tsrun": "^1.2.12",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.52",
-  }
+    "@pushrocks/tapbundle": "^3.2.10",
+    "@types/node": "^14.14.22",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,27 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const npmExtra = require("../dist/index");
-let testNpmextra;
-describe('npmextra', function () {
-    it('should create a new Npmtextra instance', function () {
-        testNpmextra = new npmExtra.Npmextra('./test/');
-        should(testNpmextra).be.instanceof(npmExtra.Npmextra);
-    });
-    it('should state wether a npmextra.json exists', function () {
-        should(testNpmextra.npmextraJsonExists).be.true();
-    });
-    it('should pass through default value, if not overriden by config from file', function () {
-        let testData = testNpmextra.dataFor('testTool', { someKey2: 'someValue2' });
-        console.log(testData);
-        should(testData).have.ownProperty('someKey2');
-    });
-    it('should read a config file', function () {
-        let testData = testNpmextra.dataFor('testTool', {
-            someKey2: 'someValue2'
-        });
-        should(testData).have.ownProperty('someKey2');
-        should(testData.testValue).equal(2);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQixpQ0FBZ0M7QUFFaEMsMENBQTBDO0FBRTFDLElBQUksWUFBK0IsQ0FBQTtBQUVuQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQyx3Q0FBd0MsRUFBRTtRQUN6QyxZQUFZLEdBQUcsSUFBSSxRQUFRLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFBO1FBQy9DLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUN6RCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw0Q0FBNEMsRUFBRTtRQUM3QyxNQUFNLENBQUMsWUFBWSxDQUFDLGtCQUFrQixDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFBO0lBQ3JELENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLHlFQUF5RSxFQUFDO1FBQ3pFLElBQUksUUFBUSxHQUFHLFlBQVksQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLEVBQUMsUUFBUSxFQUFFLFlBQVksRUFBQyxDQUFDLENBQUE7UUFDekUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUNyQixNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxZQUFZLENBQUMsT0FBTyxDQUMvQixVQUFVLEVBQ1Y7WUFDSSxRQUFRLEVBQUUsWUFBWTtTQUN6QixDQUNKLENBQUE7UUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUM3QyxNQUFNLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN2QyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.kvstore.ts

@@ -0,0 +1,25 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+
+import * as npmextra from '../ts/index';
+
+let myKeyValueStore: npmextra.KeyValueStore;
+
+tap.test('should create a keyValueStore', async () => {
+  myKeyValueStore = new npmextra.KeyValueStore('custom', 'test');
+  expect(myKeyValueStore).to.be.instanceof(npmextra.KeyValueStore);
+});
+
+tap.test('expect result to be empty', async () => {
+  let result = myKeyValueStore.readAll();
+  // tslint:disable-next-line:no-unused-expression
+  expect(result).to.be.empty;
+});
+
+tap.test('expect to add an object to the kv Store', async () => {
+  await myKeyValueStore.writeAll({
+    myKey: 'myValue',
+  });
+  await expect(myKeyValueStore.readKey('myKey')).to.eventually.equal('myValue');
+});
+
+tap.start();

test/test.ts

@@ -1,32 +1,33 @@
-import 'typings-test'
+import { expect, tap } from '@pushrocks/tapbundle';
-import path = require('path')
+import path = require('path');
-import * as should from 'should'
 
-import npmExtra = require('../dist/index')
+// module to test
+import npmExtra = require('../ts/index');
 
-let testNpmextra: npmExtra.Npmextra
+let testNpmextra: npmExtra.Npmextra;
 
-describe('npmextra',function(){
+tap.test('should create a new Npmtextra instance', async () => {
-    it('should create a new Npmtextra instance', function(){
+  testNpmextra = new npmExtra.Npmextra('./test/');
-        testNpmextra = new npmExtra.Npmextra('./test/')
+  expect(testNpmextra).be.instanceof(npmExtra.Npmextra);
-        should(testNpmextra).be.instanceof(npmExtra.Npmextra)
+});
-    })
+
-    it('should state wether a npmextra.json exists', function() {
+tap.test('should state wether a npmextra.json exists', async () => {
-        should(testNpmextra.npmextraJsonExists).be.true()
+  // tslint:disable-next-line:no-unused-expression
-    })
+  expect(testNpmextra.npmextraJsonExists).be.true;
-    it('should pass through default value, if not overriden by config from file',function(){
+});
-        let testData = testNpmextra.dataFor('testTool', {someKey2: 'someValue2'})
+
-        console.log(testData)
+tap.test('should pass through default value, if not overriden by config from file', async () => {
-        should(testData).have.ownProperty('someKey2')
+  let testData = testNpmextra.dataFor('testTool', { someKey2: 'someValue2' });
-    })
+  console.log(testData);
-    it('should read a config file',function(){
+  expect(testData).have.ownProperty('someKey2');
-        let testData = testNpmextra.dataFor(
+});
-            'testTool',
+
-            {
+tap.test('should read a config file', async () => {
-                someKey2: 'someValue2'
+  let testData = testNpmextra.dataFor<any>('testTool', {
-            }
+    someKey2: 'someValue2',
-        )
+  });
-        should(testData).have.ownProperty('someKey2')
+  expect(testData).have.ownProperty('someKey2');
-        should(testData.testValue).equal(2)
+  expect(testData.testValue).equal(2);
-    })
+});
-})
+
+tap.start();

ts/index.ts

@@ -1,4 +1,4 @@
-import * as plugins from './npmextra.plugins'
+import * as plugins from './npmextra.plugins';
 
-export * from './npmextra.classes.npmextra'
+export * from './npmextra.classes.npmextra';
-export * from './npmextra.classes.keyvaluestore'
+export * from './npmextra.classes.keyvaluestore';

ts/npmextra.classes.keyvaluestore.ts

@@ -1,33 +1,112 @@
-import * as plugins from './npmextra.plugins'
+import * as plugins from './npmextra.plugins';
-
+import * as paths from './npmextra.paths';
-export type keyValueStoreTypes = 'path' | 'gitProject'
 
+import { Task } from '@pushrocks/taskbuffer';
 
+export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
 
+/**
+ * kvStore is a simple key vlaue store to store data about projects between runs
+ */
 export class KeyValueStore {
-    constructor(optionsArg: {
+  private dataObject: any = {};
-        type: keyValueStoreTypes
+  private deletedObject: any = {};
-    }) {
+  public syncTask = new Task({
-
+    name: 'syncTask',
+    buffered: true,
+    bufferMax: 1,
+    execDelay: 0,
+    taskFunction: async () => {
+      this.dataObject = {
+        ...plugins.smartfile.fs.toObjectSync(this.filePath),
+        ...this.dataObject,
+      };
+      for (const key of Object.keys(this.deletedObject)) {
+        delete this.dataObject[key];
+      }
+      this.deletedObject = {};
+      await plugins.smartfile.memory.toFs(JSON.stringify(this.dataObject), this.filePath);
+    },
+  });
+  /**
+   * computes the identity
+   */
+  private initFilePath = () => {
+    // determine the right base directory
+    let baseDir: string;
+    if (this.type === 'custom') {
+      baseDir = paths.kvCustomDir;
+    } else if (this.type === 'gitProject') {
+      baseDir = paths.kvGitDir;
+    } else if (this.type === 'path') {
+      baseDir = paths.kvPathDir;
     }
-    /**
+    this.filePath = plugins.path.join(baseDir, this.identity + '.json');
- * reads a keyValueFile from disk
+    plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
- */
+    plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
-let kvRead () {
+    plugins.smartfile.fs.ensureDirSync(paths.kvPathDir);
+    plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
+  };
 
-}
+  public type: TKeyValueStore; // the type of the kvStore
-
+  public identity: string; // the identity of the kvStore
-/**
+  public filePath: string; // the filePath of the kvStore
- * writes a key value file to disk
+
- */
+  /**
-let kvWrite () {
+   * the constructor of keyvalue store
-
+   * @param typeArg
-}
+   * @param customStringArg
-
+   */
-/**
+  constructor(typeArg: TKeyValueStore, customStringArg: string) {
- * wipes a key value store from disk
+    // set kvStoreType
- */
+    this.type = typeArg;
-let kevWipe () {
+    this.identity = customStringArg;
-
+    this.initFilePath();
-}
+  }
+
+  /**
+   * reads all keyValue pairs at once and returns them
+   */
+  public async readAll() {
+    await this.syncTask.trigger();
+    return this.dataObject;
+  }
+
+  /**
+   * reads a keyValueFile from disk
+   */
+  public async readKey(keyArg: string) {
+    await this.syncTask.trigger();
+    return this.dataObject[keyArg];
+  }
+
+  /**
+   * writes a specific key to the keyValueStore
+   */
+  public async writeKey(keyArg: string, valueArg: any) {
+    await this.writeAll({
+      [keyArg]: valueArg,
+    });
+  }
+
+  public async deleteKey(keyArg: string) {
+    this.deletedObject[keyArg] = this.dataObject[keyArg];
+    await this.syncTask.trigger();
+  }
+
+  /**
+   * writes all keyValue pairs in the object argument
+   */
+  public async writeAll(keyValueObject) {
+    this.dataObject = { ...this.dataObject, ...keyValueObject };
+    await this.syncTask.trigger();
+  }
+
+  /**
+   * wipes a key value store from disk
+   */
+  public async wipe() {
+    this.dataObject = {};
+    await plugins.smartfile.fs.remove(this.filePath);
+  }
 }

ts/npmextra.classes.npmextra.ts

@@ -1,68 +1,72 @@
-import * as plugins from './npmextra.plugins'
+import * as plugins from './npmextra.plugins';
-import * as paths from './npmextra.paths'
+import * as paths from './npmextra.paths';
 
 /**
  * Npmextra class allows easy configuration of tools
  */
 export class Npmextra {
-    cwd: string
+  cwd: string;
-    lookupPath: string
+  lookupPath: string;
-    npmextraJsonExists: boolean
+  npmextraJsonExists: boolean;
-    npmextraJsonData: boolean
+  npmextraJsonData: any;
 
-    /**
+  /**
-     * creates instance of Npmextra
+   * creates instance of Npmextra
-     */
+   */
-    constructor(cwdArg?: string) {
+  constructor(cwdArg?: string) {
-        if (cwdArg) {
+    if (cwdArg) {
-            this.cwd = cwdArg
+      this.cwd = cwdArg;
-        } else {
+    } else {
-            this.cwd = paths.cwd
+      this.cwd = paths.cwd;
-        }
-        this.checkLookupPath()
-        this.checkNpmextraJsonExists()
-        this.checkNpmextraJsonData()
     }
+    this.checkLookupPath();
+    this.checkNpmextraJsonExists();
+    this.checkNpmextraJsonData();
+  }
 
-    /**
+  /**
-     * merges the supplied options with the ones from npmextra.json
+   * merges the supplied options with the ones from npmextra.json
-     */
+   */
-    dataFor(toolnameArg: string, defaultOptionsArg: any) {
+  dataFor<IToolConfig>(toolnameArg: string, defaultOptionsArg: any): IToolConfig {
-        let npmextraToolOptions
+    let npmextraToolOptions;
-        if(this.npmextraJsonData[toolnameArg]) {
+    if (this.npmextraJsonData[toolnameArg]) {
-            npmextraToolOptions = this.npmextraJsonData[toolnameArg]
+      npmextraToolOptions = this.npmextraJsonData[toolnameArg];
-        } else {
+    } else {
-            npmextraToolOptions = {}
+      npmextraToolOptions = {};
-        }
-        let mergedOptions = plugins.lodash.merge({}, defaultOptionsArg, npmextraToolOptions)
-        return mergedOptions
     }
+    let mergedOptions = {
+      ...defaultOptionsArg,
+      ...npmextraToolOptions,
+    };
+    return mergedOptions;
+  }
 
-    /**
+  /**
-     * checks if the JSON exists
+   * checks if the JSON exists
-     */
+   */
-    private checkNpmextraJsonExists() {
+  private checkNpmextraJsonExists() {
-        this.npmextraJsonExists = plugins.smartfile.fs.fileExistsSync(this.lookupPath)
+    this.npmextraJsonExists = plugins.smartfile.fs.fileExistsSync(this.lookupPath);
+  }
+
+  /**
+   * gets lookupPath
+   */
+  private checkLookupPath() {
+    if (this.cwd) {
+      this.lookupPath = plugins.path.join(this.cwd, 'npmextra.json');
+    } else {
+      this.lookupPath = paths.configFile;
     }
+  }
 
-    /**
+  /**
-     * gets lookupPath
+   * get npmextraJsonData
-     */
+   */
-    private checkLookupPath() {
+  private checkNpmextraJsonData() {
-        if (this.cwd) {
+    if (this.npmextraJsonExists) {
-            this.lookupPath = plugins.path.join(this.cwd, 'npmextra.json')
+      this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath);
-        } else {
+    } else {
-            this.lookupPath = paths.configFile
+      this.npmextraJsonData = {};
-        };
     }
-
+  }
-    /**
-     * get npmextraJsonData
-     */
-    private checkNpmextraJsonData() {
-        if (this.npmextraJsonExists) {
-            this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath)
-        }
-    }
-
 }

ts/npmextra.paths.ts

@@ -1,8 +1,34 @@
-import * as plugins from './npmextra.plugins'
+import * as plugins from './npmextra.plugins';
 
 // directories
-export let cwd = process.cwd()
+export let cwd = process.cwd();
-export let packageDir = plugins.path.join(__dirname,'../')
+export let packageDir = plugins.path.join(__dirname, '../');
+
+// ----------------------
+// keyValueStore specific
+// ----------------------
+
+export let home = plugins.smartpath.get.home();
+
+/**
+ * keyValue base path
+ */
+export let kvBase = plugins.path.join(home, '.npmextra/kv');
+
+/**
+ * the base directory for custom string based key value store
+ */
+export let kvCustomDir = plugins.path.join(kvBase, 'custom');
+
+/**
+ * the subdir for git based keyValue
+ */
+export let kvGitDir = plugins.path.join(kvBase, 'git');
+
+/**
+ * keyValue for path based keyValue store
+ */
+export let kvPathDir = plugins.path.join(kvBase, 'path');
 
 // files
-export let configFile = plugins.path.join(cwd,'npmextra.json')
+export let configFile = plugins.path.join(cwd, 'npmextra.json');

ts/npmextra.plugins.ts

@@ -1,6 +1,8 @@
-import 'typings-global'
+import * as beautylog from '@pushrocks/smartlog';
-export import beautylog = require('beautylog')
+import * as path from 'path';
-export import lodash = require('lodash')
+import * as smartfile from '@pushrocks/smartfile';
-export import path = require('path')
+import * as smartpath from '@pushrocks/smartpath';
-export import smartfile = require('smartfile')
+import * as smartpromise from '@pushrocks/smartpromise';
-export import q = require('q')
+import * as taskbuffer from '@pushrocks/taskbuffer';
+
+export { beautylog, path, smartfile, smartpath, smartpromise, taskbuffer };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
+}