3.0.6

.gitignore

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

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,21 +37,11 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +53,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -118,6 +110,7 @@ pages:
   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:
@@ -130,13 +123,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

README.md

@@ -1,33 +1,61 @@
-# npmextra
-
+# @pushrocks/npmextra
 do more with npm
 
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmextra)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/npmextra)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmextra)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmextra/)
+## 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/npmextra.svg)](https://www.npmjs.com/package/npmextra)
-[![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/)
+[![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.
 
-For further information read the linked docs at the top of this README.
+## 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)
+| 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://push.rocks)
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

docs/index.md

@@ -1,66 +0,0 @@
-# npmextra
-
-do more with npm
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmextra)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/npmextra)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmextra)
-[![docs](https://pushrocks.gitlab.io/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)
-[![npm downloads per month](https://img.shields.io/npm/dm/npmextra.svg)](https://www.npmjs.com/package/npmextra)
-[![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
-
-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://push.rocks)

npmextra.json

@@ -7,5 +7,15 @@
     "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,6 +1,6 @@
 {
   "name": "@pushrocks/npmextra",
-  "version": "3.0.1",
+  "version": "3.0.6",
   "private": false,
   "description": "do more with npm",
   "main": "dist/index.js",
@@ -20,18 +20,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@pushrocks/smartfile": "^6.0.8",
-    "@pushrocks/smartlog": "^2.0.1",
+    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smartlog": "^2.0.19",
     "@pushrocks/smartpath": "^4.0.1",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/taskbuffer": "^2.0.5",
-    "smartlodash": "^1.0.1"
+    "@pushrocks/smartpromise": "^3.0.5",
+    "@pushrocks/taskbuffer": "^2.0.10"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.9.4"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@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"
   }
 }

ts/npmextra.classes.keyvaluestore.ts

@@ -9,34 +9,49 @@ export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
  * kvStore is a simple key vlaue store to store data about projects between runs
  */
 export class KeyValueStore {
-  dataObject: any;
-  deletedObject: any = {};
-  initialReadTask = new TaskOnce({
-    taskFunction: async () => {
-      this.dataObject = plugins.smartfile.fs.toObjectSync(this.filePath);
-    }
-  });
-  syncTask = new Task({
+  private dataObject: any = {};
+  private deletedObject: any = {};
+  public syncTask = new Task({
+    name: 'syncTask',
     buffered: true,
     bufferMax: 2,
     execDelay: 500,
     taskFunction: async () => {
-      this.dataObject = plugins.smartlodash.merge(
-        {},
-        plugins.smartfile.fs.toObjectSync(this.filePath),
-        this.dataObject
-      );
-      for (let key in this.deletedObject) {
+      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);
     },
-    name: 'syncTask'
   });
-  type: TKeyValueStore; // the type of the kvStore
-  identity: string; // the identity of the kvStore
-  filePath: string; // the filePath of the kvStore
+  /**
+   * 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
@@ -53,68 +68,46 @@ export class KeyValueStore {
   /**
    * reads all keyValue pairs at once and returns them
    */
-  async readAll() {
-    await this.initialReadTask.trigger();
-    this.syncTask.trigger();
+  public async readAll() {
+    await this.syncTask.trigger();
     return this.dataObject;
   }
 
   /**
    * reads a keyValueFile from disk
    */
-  async readKey(keyArg: string) {
-    let data = await this.readAll();
-    return data[keyArg];
+  public async readKey(keyArg: string) {
+    await this.syncTask.trigger();
+    return this.dataObject[keyArg];
   }
 
   /**
    * writes a specific key to the keyValueStore
    */
-  async writeKey(keyArg: string, valueArg: any) {
-    let writeObject: any = {};
-    writeObject[keyArg] = valueArg;
-    this.writeAll(writeObject);
+  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
    */
-  async writeAll(keyValueObject) {
-    plugins.smartlodash.merge(this.dataObject, keyValueObject);
-    this.syncTask.trigger();
+  public async writeAll(keyValueObject) {
+    this.dataObject = {...this.dataObject, ...keyValueObject};
+    await this.syncTask.trigger();
   }
 
   /**
    * wipes a key value store from disk
    */
-  async wipe() {
-    for (let key in this.dataObject) {
-      this.deletedObject[key] = this.dataObject[key];
-    }
-  }
-
-  /**
-   * updates a value
-   */
-  async update(keyObject) {}
-
-  /**
-   * 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 async wipe() {
+    this.dataObject = {};
+    await plugins.smartfile.fs.remove(this.filePath);
   }
 }

ts/npmextra.classes.npmextra.ts

@@ -34,7 +34,10 @@ export class Npmextra {
     } else {
       npmextraToolOptions = {};
     }
-    let mergedOptions = plugins.smartlodash.merge({}, defaultOptionsArg, npmextraToolOptions);
+    let mergedOptions = {
+      ...defaultOptionsArg,
+      ...npmextraToolOptions
+    };
     return mergedOptions;
   }
 

ts/npmextra.plugins.ts

@@ -1,9 +1,8 @@
 import * as beautylog from '@pushrocks/smartlog';
 import * as path from 'path';
 import * as smartfile from '@pushrocks/smartfile';
-import smartlodash from 'smartlodash';
 import * as smartpath from '@pushrocks/smartpath';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as taskbuffer from '@pushrocks/taskbuffer';
 
-export { beautylog, path, smartfile, smartpath, smartpromise, smartlodash, 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"
+}