3.0.8

.gitignore

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

.gitlab-ci.yml

@@ -1,35 +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
-- release
+  - security
+  - test
+  - 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:
+  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

.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,4 +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.

dist/index.d.ts

@@ -1,6 +0,0 @@
-export interface IDataFor {
-    toolName: string;
-    defaultSettings?: any;
-    cwd?: string;
-}
-export declare let dataFor: (optionsArg: IDataFor) => any;

dist/index.js

@@ -1,47 +0,0 @@
-"use strict";
-const plugins = require("./npmextra.plugins");
-const paths = require("./npmextra.paths");
-exports.dataFor = (optionsArg) => {
-    // handle default settings
-    if (typeof optionsArg.toolName != undefined
-        && typeof optionsArg.defaultSettings != undefined) {
-        let newDefaultOptions = {};
-        newDefaultOptions[optionsArg.toolName] = optionsArg.defaultSettings;
-        optionsArg.defaultSettings = newDefaultOptions;
-    }
-    ;
-    // set lookup path
-    let lookupPath;
-    if (optionsArg.cwd) {
-        lookupPath = plugins.path.join(optionsArg.cwd, "npmextra.json");
-    }
-    else {
-        lookupPath = paths.configFile;
-    }
-    ;
-    // get allData
-    let allData;
-    if (plugins.smartfile.fs.fileExistsSync(lookupPath)) {
-        allData = plugins.smartfile.fs.toObjectSync(lookupPath);
-    }
-    else {
-        plugins.beautylog.warn(`${lookupPath} is misssing!`);
-        allData = {};
-    }
-    ;
-    //assign all data
-    allData = plugins.lodash.merge({}, optionsArg.defaultSettings, allData);
-    if (optionsArg.toolName) {
-        if (allData[optionsArg.toolName]) {
-            return allData[optionsArg.toolName];
-        }
-        else {
-            plugins.beautylog.error(`There is no data for ${optionsArg.toolName}`);
-            return undefined;
-        }
-    }
-    else {
-        return allData;
-    }
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQVEvQixlQUFPLEdBQUcsQ0FBQyxVQUFtQjtJQUVyQywwQkFBMEI7SUFDMUIsRUFBRSxDQUFBLENBQ0UsT0FBTyxVQUFVLENBQUMsUUFBUSxJQUFJLFNBQVM7V0FDcEMsT0FBTyxVQUFVLENBQUMsZUFBZSxJQUFJLFNBQzVDLENBQUMsQ0FBQSxDQUFDO1FBQ0UsSUFBSSxpQkFBaUIsR0FBRyxFQUFFLENBQUM7UUFDM0IsaUJBQWlCLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxlQUFlLENBQUM7UUFDcEUsVUFBVSxDQUFDLGVBQWUsR0FBRyxpQkFBaUIsQ0FBQztJQUNuRCxDQUFDO0lBQUEsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixJQUFJLFVBQWlCLENBQUM7SUFDdEIsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFBLENBQUM7UUFDZixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQztJQUNsQyxDQUFDO0lBQUEsQ0FBQztJQUVGLGNBQWM7SUFDZCxJQUFJLE9BQU8sQ0FBQztJQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDaEQsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLFVBQVUsZUFBZSxDQUFDLENBQUM7UUFDckQsT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNqQixDQUFDO0lBQUEsQ0FBQztJQUVGLGlCQUFpQjtJQUNqQixPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFDLFVBQVUsQ0FBQyxlQUFlLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEUsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFBLENBQUM7UUFDcEIsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ3ZFLE1BQU0sQ0FBQyxTQUFTLENBQUM7UUFDckIsQ0FBQztJQUNMLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUM7SUFDbkIsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9

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,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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFDO0FBQzNCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQyJ9

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",
-  "version": "1.0.6",
+  "name": "@pushrocks/npmextra",
+  "version": "3.0.8",
+  "private": false,
   "description": "do more with npm",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "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.0.27",
-    "beautylog": "^5.0.14",
-    "lodash": "^4.13.1",
-    "q": "^1.4.1",
-    "smartfile": "^4.0.10",
-    "typings-global": "^1.0.6"
+    "@pushrocks/smartfile": "^8.0.8",
+    "@pushrocks/smartlog": "^2.0.39",
+    "@pushrocks/smartpath": "^4.0.3",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/taskbuffer": "^2.1.13"
   },
   "devDependencies": {
-    "@types/should": "^8.1.26",
-    "should": "^9.0.2",
-    "typings-test": "^1.0.1"
-  }
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@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,2 +0,0 @@
-import "typings-test";
-import "should";

test/test.js

@@ -1,16 +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({
-            toolName: "testTool",
-            defaultSettings: { someKey2: "someValue2" },
-            cwd: path.join(process.cwd(), "test/")
-        });
-        testData.should.have.ownProperty("someKey2");
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDO1lBQzVCLFFBQVEsRUFBQyxVQUFVO1lBQ25CLGVBQWUsRUFBQyxFQUFDLFFBQVEsRUFBQyxZQUFZLEVBQUM7WUFDdkMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQztTQUN4QyxDQUFDLENBQUM7UUFDSCxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDakQsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyJ9

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,16 +1,33 @@
-import "typings-test";
-import path = require("path");
-import "should";
+import { expect, tap } from '@pushrocks/tapbundle';
+import path = require('path');
 
-import npmExtra = require("../dist/index");
+// module to test
+import npmExtra = require('../ts/index');
 
-describe("npmextra",function(){
-    it("should read a config file",function(){
-        let testData = npmExtra.dataFor({
-            toolName:"testTool",
-            defaultSettings:{someKey2:"someValue2"},
-            cwd: path.join(process.cwd(),"test/")
-        });
-        testData.should.have.ownProperty("someKey2");
-    });
-});
+let testNpmextra: npmExtra.Npmextra;
+
+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,51 +1,4 @@
-import * as plugins from "./npmextra.plugins"
-import * as paths from "./npmextra.paths";
+import * as plugins from './npmextra.plugins';
 
-export interface IDataFor {
-    toolName:string;
-    defaultSettings?;
-    cwd?:string
-}
-
-export let dataFor = (optionsArg:IDataFor) => {
-    
-    // handle default settings
-    if(
-        typeof optionsArg.toolName != undefined
-        && typeof optionsArg.defaultSettings != undefined
-    ){
-        let newDefaultOptions = {};
-        newDefaultOptions[optionsArg.toolName] = optionsArg.defaultSettings;
-        optionsArg.defaultSettings = newDefaultOptions;
-    };
-
-    // set lookup path
-    let lookupPath:string;
-    if(optionsArg.cwd){
-        lookupPath = plugins.path.join(optionsArg.cwd,"npmextra.json");
-    } else {
-        lookupPath = paths.configFile;
-    };
-    
-    // get allData
-    let allData;
-    if(plugins.smartfile.fs.fileExistsSync(lookupPath)){
-        allData = plugins.smartfile.fs.toObjectSync(lookupPath);
-    } else {
-        plugins.beautylog.warn(`${lookupPath} is misssing!`);
-        allData = {};
-    };
-
-    //assign all data
-    allData = plugins.lodash.merge({},optionsArg.defaultSettings,allData);
-    if(optionsArg.toolName){
-        if(allData[optionsArg.toolName]){
-            return allData[optionsArg.toolName];
-        } else {
-            plugins.beautylog.error(`There is no data for ${optionsArg.toolName}`);
-            return undefined;
-        }
-    } else {
-        return allData;
-    }
-}
+export * from './npmextra.classes.npmextra';
+export * from './npmextra.classes.keyvaluestore';

ts/npmextra.classes.keyvaluestore.ts

@@ -0,0 +1,112 @@
+import * as plugins from './npmextra.plugins';
+import * as paths from './npmextra.paths';
+
+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 {
+  private dataObject: any = {};
+  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');
+    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,6 +1,8 @@
-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");
+import * as beautylog from '@pushrocks/smartlog';
+import * as path from 'path';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpath from '@pushrocks/smartpath';
+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"
+}