3.0.6

.gitignore

@@ -1,3 +1,19 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
-docs/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches and builds
+.yarn/
+.cache/
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,35 +1,125 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
+- metadata
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
+  script:
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - 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: {}

README.md

@@ -0,0 +1,61 @@
+# @pushrocks/npmextra
+do more with npm
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/npmextra)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/npmextra)
+* [github.com (source mirror)](https://github.com/pushrocks/npmextra)
+* [docs (typedoc)](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)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/npmextra.svg)](https://www.npmjs.com/package/@pushrocks/npmextra)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/npmextra/badge.svg)](https://snyk.io/test/npm/@pushrocks/npmextra)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+## Using npmextra for managing toolconfigs
+
+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 { Npmextra } from 'npmextra';
+
+let myNpmExtra = new Npmextra('my/path/to/cwd'); // cwd argument is optional
+mergedData = myNpmExtra.dataFor('sometool', {
+  // 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
+});
+```
+
+### Tools that already use the config feature of npmextra
+
+- [npmts](https://www.npmjs.com/package/npmts)
+- [npmci](https://www.npmjs.com/package/npmci)
+- [npmdocker](https://www.npmjs.com/package/npmdocker)
+
+## Using the KeyValueStore
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

dist/index.d.ts

@@ -1 +0,0 @@
-export declare let dataFor: (toolNameArg: string, cwdArg?: string) => any;

dist/index.js

@@ -1,31 +0,0 @@
-"use strict";
-const plugins = require("./npmextra.plugins");
-const paths = require("./npmextra.paths");
-let allData;
-exports.dataFor = (toolNameArg, cwdArg) => {
-    if (typeof allData == "undefined") {
-        let lookupPath;
-        if (cwdArg) {
-            lookupPath = plugins.path.join(cwdArg, "npmextra.json");
-        }
-        else {
-            lookupPath = paths.configFile;
-        }
-        ;
-        allData = plugins.smartfile.fs.toObjectSync(plugins.path.join(lookupPath));
-    }
-    ;
-    if (toolNameArg) {
-        if (allData[toolNameArg]) {
-            return allData[toolNameArg];
-        }
-        else {
-            plugins.beautylog.error(`There is no data for ${toolNameArg}`);
-            return undefined;
-        }
-    }
-    else {
-        return allData;
-    }
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQUMxQyxJQUFJLE9BQU8sQ0FBQztBQUVELGVBQU8sR0FBRyxDQUFDLFdBQWtCLEVBQUMsTUFBYztJQUNuRCxFQUFFLENBQUEsQ0FBQyxPQUFPLE9BQU8sSUFBSSxXQUFXLENBQUMsQ0FBQSxDQUFDO1FBQzlCLElBQUksVUFBVSxDQUFDO1FBQ2YsRUFBRSxDQUFBLENBQUMsTUFBTSxDQUFDLENBQUEsQ0FBQztZQUNQLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUMsZUFBZSxDQUFDLENBQUM7UUFDM0QsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osVUFBVSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUM7UUFDbEMsQ0FBQztRQUFBLENBQUM7UUFDRixPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUN2QyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FDaEMsQ0FBQztJQUNOLENBQUM7SUFBQSxDQUFDO0lBQ0YsRUFBRSxDQUFBLENBQUMsV0FBVyxDQUFDLENBQUEsQ0FBQztRQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDckIsTUFBTSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNoQyxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyx3QkFBd0IsV0FBVyxFQUFFLENBQUMsQ0FBQztZQUMvRCxNQUFNLENBQUMsU0FBUyxDQUFDO1FBQ3JCLENBQUM7SUFDTCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsT0FBTyxDQUFDO0lBQ25CLENBQUM7QUFDTCxDQUFDLENBQUEifQ==

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, "../");
-//
-exports.configFile = plugins.path.join(exports.cwd, "npmextra.json");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQW9CLENBQUMsQ0FBQTtBQUU5QyxjQUFjO0FBQ0gsV0FBRyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztBQUNwQixrQkFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxLQUFLLENBQUMsQ0FBQztBQUUzRCxFQUFFO0FBQ1Msa0JBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFHLEVBQUMsZUFBZSxDQUFDLENBQUMifQ==

dist/npmextra.plugins.d.ts

@@ -1,5 +0,0 @@
-import "typings-global";
-export import beautylog = require("beautylog");
-export import path = require("path");
-export import smartfile = require("smartfile");
-export import q = require("q");

dist/npmextra.plugins.js

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

npmextra.json

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

package.json

@@ -1,10 +1,13 @@
 {
-  "name": "npmextra",
+  "name": "@pushrocks/npmextra",
-  "version": "1.0.1",
+  "version": "3.0.6",
+  "private": false,
   "description": "do more with npm",
   "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -17,14 +20,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@types/q": "0.0.27",
+    "@pushrocks/smartfile": "^7.0.4",
-    "beautylog": "^5.0.14",
+    "@pushrocks/smartlog": "^2.0.19",
-    "q": "^1.4.1",
+    "@pushrocks/smartpath": "^4.0.1",
-    "smartfile": "^4.0.10",
+    "@pushrocks/smartpromise": "^3.0.5",
-    "typings-global": "^1.0.6"
+    "@pushrocks/taskbuffer": "^2.0.10"
   },
   "devDependencies": {
-    "should": "^9.0.2",
+    "@gitzone/tsbuild": "^2.1.17",
-    "typings-test": "^1.0.1"
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.5",
+    "tslint": "^5.20.0",
+    "tslint-config-prettier": "^1.18.0"
   }
 }

test/test.d.ts

@@ -1,2 +0,0 @@
-import "typings-test";
-import "should";

test/test.js

@@ -1,12 +0,0 @@
-"use strict";
-require("typings-test");
-const path = require("path");
-require("should");
-const npmExtra = require("../dist/index");
-describe("npmextra", function () {
-    it("should read a config file", function () {
-        let testData = npmExtra.dataFor("testTool", path.join(process.cwd(), "test/"));
-        console.log(testData);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDLFVBQVUsRUFBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO1FBQzdFLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDMUIsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyJ9

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

ts/index.ts

@@ -1,27 +1,4 @@
-import * as plugins from "./npmextra.plugins"
+import * as plugins from './npmextra.plugins';
-import * as paths from "./npmextra.paths";
-let allData;
 
-export let dataFor = (toolNameArg:string,cwdArg?:string) => {
+export * from './npmextra.classes.npmextra';
-    if(typeof allData == "undefined"){
+export * from './npmextra.classes.keyvaluestore';
-        let lookupPath;
-        if(cwdArg){
-            lookupPath = plugins.path.join(cwdArg,"npmextra.json");
-        } else {
-            lookupPath = paths.configFile;
-        };
-        allData = plugins.smartfile.fs.toObjectSync(
-            plugins.path.join(lookupPath)
-        );
-    };
-    if(toolNameArg){
-        if(allData[toolNameArg]){
-            return allData[toolNameArg];
-        } else {
-            plugins.beautylog.error(`There is no data for ${toolNameArg}`);
-            return undefined;
-        }
-    } else {
-        return allData;
-    }
-}

ts/npmextra.classes.keyvaluestore.ts

@@ -0,0 +1,113 @@
+import * as plugins from './npmextra.plugins';
+import * as paths from './npmextra.paths';
+
+import { Task, TaskOnce } 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 {
+  private dataObject: any = {};
+  private deletedObject: any = {};
+  public syncTask = new Task({
+    name: 'syncTask',
+    buffered: true,
+    bufferMax: 2,
+    execDelay: 500,
+    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');
+    plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
+    plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
+    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
+
+  /**
+   * the constructor of keyvalue store
+   * @param typeArg
+   * @param customStringArg
+   */
+  constructor(typeArg: TKeyValueStore, customStringArg: string) {
+    // set kvStoreType
+    this.type = typeArg;
+    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

@@ -0,0 +1,72 @@
+import * as plugins from './npmextra.plugins';
+import * as paths from './npmextra.paths';
+
+/**
+ * Npmextra class allows easy configuration of tools
+ */
+export class Npmextra {
+  cwd: string;
+  lookupPath: string;
+  npmextraJsonExists: boolean;
+  npmextraJsonData: any;
+
+  /**
+   * creates instance of Npmextra
+   */
+  constructor(cwdArg?: string) {
+    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<IToolConfig>(toolnameArg: string, defaultOptionsArg: any): IToolConfig {
+    let npmextraToolOptions;
+    if (this.npmextraJsonData[toolnameArg]) {
+      npmextraToolOptions = this.npmextraJsonData[toolnameArg];
+    } else {
+      npmextraToolOptions = {};
+    }
+    let mergedOptions = {
+      ...defaultOptionsArg,
+      ...npmextraToolOptions
+    };
+    return mergedOptions;
+  }
+
+  /**
+   * checks if the JSON exists
+   */
+  private checkNpmextraJsonExists() {
+    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;
+    }
+  }
+
+  /**
+   * get npmextraJsonData
+   */
+  private checkNpmextraJsonData() {
+    if (this.npmextraJsonExists) {
+      this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath);
+    } else {
+      this.npmextraJsonData = {};
+    }
+  }
+}

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 packageDir = plugins.path.join(__dirname,"../");
+export let packageDir = plugins.path.join(__dirname, '../');
 
-//
+// ----------------------
-export let configFile = plugins.path.join(cwd,"npmextra.json"); 
+// 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');

ts/npmextra.plugins.ts

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

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"
+}