3.0.9

.gitignore

@@ -8,12 +8,13 @@ pages/
 # installs
 node_modules/
 
-# caches and builds
+# caches
 .yarn/
 .cache/
+.rpt2_cache
+
+# builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,102 +18,114 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+
+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
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.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,61 +0,0 @@
-# @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)

npmextra.json

@@ -9,6 +9,7 @@
     }
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/npmextra",
-  "version": "3.0.5",
+  "version": "3.0.9",
   "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": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -20,19 +20,34 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smartfile": "^8.0.8",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartlog": "^2.0.39",
-    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpromise": "^3.1.3",
-    "@pushrocks/taskbuffer": "^2.0.7"
+    "@pushrocks/taskbuffer": "^2.1.13"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^3.2.10",
-    "@types/node": "^12.0.0",
+    "@types/node": "^14.14.22",
-    "tslint": "^5.16.0",
+    "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"
+  ]
 }

readme.md

@@ -0,0 +1,73 @@
+# @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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/npmextra/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/npmextra/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/npmextra)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/npmextra)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/npmextra)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/npmextra)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/npmextra)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+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
+
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.kvstore.ts

@@ -17,7 +17,7 @@ tap.test('expect result to be empty', async () => {
 
 tap.test('expect to add an object to the kv Store', async () => {
   await myKeyValueStore.writeAll({
-    myKey: 'myValue'
+    myKey: 'myValue',
   });
   await expect(myKeyValueStore.readKey('myKey')).to.eventually.equal('myValue');
 });

test/test.ts

@@ -24,7 +24,7 @@ tap.test('should pass through default value, if not overriden by config from fil
 
 tap.test('should read a config file', async () => {
   let testData = testNpmextra.dataFor<any>('testTool', {
-    someKey2: 'someValue2'
+    someKey2: 'someValue2',
   });
   expect(testData).have.ownProperty('someKey2');
   expect(testData.testValue).equal(2);

ts/npmextra.classes.keyvaluestore.ts

@@ -1,7 +1,7 @@
 import * as plugins from './npmextra.plugins';
 import * as paths from './npmextra.paths';
 
-import { Task, TaskOnce } from '@pushrocks/taskbuffer';
+import { Task } from '@pushrocks/taskbuffer';
 
 export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
 
@@ -9,21 +9,17 @@ export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
  * kvStore is a simple key vlaue store to store data about projects between runs
  */
 export class KeyValueStore {
-  public dataObject: any;
+  private dataObject: any = {};
-  public deletedObject: any = {};
+  private deletedObject: any = {};
-  public initialReadTask = new TaskOnce({
-    taskFunction: async () => {
-      this.dataObject = plugins.smartfile.fs.toObjectSync(this.filePath);
-    }
-  });
   public syncTask = new Task({
+    name: 'syncTask',
     buffered: true,
-    bufferMax: 2,
+    bufferMax: 1,
-    execDelay: 500,
+    execDelay: 0,
     taskFunction: async () => {
       this.dataObject = {
         ...plugins.smartfile.fs.toObjectSync(this.filePath),
-        ...this.dataObject
+        ...this.dataObject,
       };
       for (const key of Object.keys(this.deletedObject)) {
         delete this.dataObject[key];
@@ -31,8 +27,27 @@ export class KeyValueStore {
       this.deletedObject = {};
       await plugins.smartfile.memory.toFs(JSON.stringify(this.dataObject), this.filePath);
     },
-    name: 'syncTask'
   });
+  /**
+   * 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
@@ -53,8 +68,7 @@ export class KeyValueStore {
    * reads all keyValue pairs at once and returns them
    */
   public async readAll() {
-    await this.initialReadTask.trigger();
+    await this.syncTask.trigger();
-    this.syncTask.trigger();
     return this.dataObject;
   }
 
@@ -62,58 +76,37 @@ export class KeyValueStore {
    * reads a keyValueFile from disk
    */
   public async readKey(keyArg: string) {
-    let data = await this.readAll();
+    await this.syncTask.trigger();
-    return data[keyArg];
+    return this.dataObject[keyArg];
   }
 
   /**
    * writes a specific key to the keyValueStore
    */
-  async writeKey(keyArg: string, valueArg: any) {
+  public async writeKey(keyArg: string, valueArg: any) {
-    let writeObject: any = {};
+    await this.writeAll({
-    writeObject[keyArg] = valueArg;
+      [keyArg]: valueArg,
-    this.writeAll(writeObject);
+    });
+  }
+
+  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};
+    this.dataObject = { ...this.dataObject, ...keyValueObject };
-    this.syncTask.trigger();
+    await this.syncTask.trigger();
   }
 
   /**
    * wipes a key value store from disk
    */
   public async wipe() {
-    for (let key in this.dataObject) {
+    this.dataObject = {};
-      this.deletedObject[key] = this.dataObject[key];
+    await plugins.smartfile.fs.remove(this.filePath);
-    }
-  }
-
-  /**
-   * updates a value
-   */
-  public 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, '{}');
   }
 }

ts/npmextra.classes.npmextra.ts

@@ -36,7 +36,7 @@ export class Npmextra {
     }
     let mergedOptions = {
       ...defaultOptionsArg,
-      ...npmextraToolOptions
+      ...npmextraToolOptions,
     };
     return mergedOptions;
   }