4.0.5

.gitignore

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

.gitlab-ci.yml

@@ -1,125 +1,122 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-  - npmci git mirror
+    - 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
-  - notpriv
+    - docker
+  allow_failure: true
 
-snyk:
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
 
 # ====================
 # 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:
+testStable:
   stage: test
   script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - docker
+
+testBuild:
   stage: test
   script:
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   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]
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci node install stable 
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -127,15 +124,5 @@ pages:
   artifacts:
     expire_in: 1 week
     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
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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,29 +0,0 @@
-# smartcli
-
-nodejs wrapper for CLI related tasks
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartcli)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartcli)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartcli)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartcli/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartcli/badges/master/build.svg)](https://GitLab.com/pushrocks/smartcli/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartcli/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartcli.svg)](https://www.npmjs.com/package/smartcli)
-[![Dependency Status](https://david-dm.org/pushrocks/smartcli.svg)](https://david-dm.org/pushrocks/smartcli)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartcli/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartcli/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartcli/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartcli)
-[![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/)
-
-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://)

dist/index.d.ts

@@ -1 +0,0 @@
-export { Smartcli } from './smartcli.classes.smartcli';

dist/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var smartcli_classes_smartcli_1 = require("./smartcli.classes.smartcli");
-exports.Smartcli = smartcli_classes_smartcli_1.Smartcli;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHlFQUF1RDtBQUE5QywrQ0FBQSxRQUFRLENBQUEifQ==

dist/smartcli.classes.smartcli.d.ts

@@ -1,72 +0,0 @@
-import * as smartq from 'smartq';
-import { Subject } from 'rxjs';
-import * as plugins from './smartcli.plugins';
-export interface ICommandPromiseObject {
-    commandName: string;
-    promise: Promise<void>;
-}
-export interface ITriggerObservableObject {
-    triggerName: string;
-    subject: Subject<any>;
-}
-/**
- * class to create a new instance of Smartcli. Handles parsing of command line arguments.
- */
-export declare class Smartcli {
-    argv: any;
-    questionsDone: any;
-    parseStarted: smartq.Deferred<any>;
-    commands: any;
-    questions: any;
-    version: string;
-    private onlyOnProcessEnvCliCall;
-    /**
-     * map of all Trigger/Observable objects to keep track
-     */
-    allTriggerObservablesMap: plugins.lik.Objectmap<ITriggerObservableObject>;
-    /**
-     * The constructor of Smartcli
-     */
-    constructor();
-    /**
-     * halts any execution of commands if (process.env.CLI_CALL === false)
-     */
-    onlyTriggerOnProcessEnvCliCall(): void;
-    /**
-     * adds an alias, meaning one equals the other in terms of command execution.
-     */
-    addCommandAlias(keyArg: any, aliasArg: any): void;
-    /**
-     * adds a Command by returning a Promise that reacts to the specific commandString given.
-     * Note: in e.g. "npm install something" the "install" is considered the command.
-     */
-    addCommand(commandNameArg: string): Subject<any>;
-    /**
-     * adds a Trigger. Like addCommand(), but returns an subscribable observable
-     */
-    addTrigger(triggerNameArg: string): Subject<any>;
-    /**
-     * execute trigger by name
-     * @param commandNameArg - the name of the command to trigger
-     */
-    trigger(triggerName: string): Subject<any>;
-    getTriggerSubject(triggerName: string): Subject<any>;
-    /**
-     * allows to specify help text to be printed above the rest of the help text
-     */
-    addHelp(optionsArg: {
-        helpText: string;
-    }): void;
-    /**
-     * specify version to be printed for -v --version
-     */
-    addVersion(versionArg: string): void;
-    /**
-     * adds a trigger that is called when no command is specified
-     */
-    standardTask(): Subject<any>;
-    /**
-     * start the process of evaluating commands
-     */
-    startParse(): void;
-}

dist/smartcli.classes.smartcli.js

@@ -1,139 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const smartq = require("smartq");
-const rxjs_1 = require("rxjs");
-const plugins = require("./smartcli.plugins");
-// import classes
-const lik_1 = require("lik");
-/**
- * class to create a new instance of Smartcli. Handles parsing of command line arguments.
- */
-class Smartcli {
-    /**
-     * The constructor of Smartcli
-     */
-    constructor() {
-        this.onlyOnProcessEnvCliCall = false;
-        /**
-         * map of all Trigger/Observable objects to keep track
-         */
-        this.allTriggerObservablesMap = new lik_1.Objectmap();
-        this.argv = plugins.yargs;
-        this.questionsDone = smartq.defer();
-        this.parseStarted = smartq.defer();
-    }
-    /**
-     * halts any execution of commands if (process.env.CLI_CALL === false)
-     */
-    onlyTriggerOnProcessEnvCliCall() {
-        this.onlyOnProcessEnvCliCall = true;
-    }
-    /**
-     * adds an alias, meaning one equals the other in terms of command execution.
-     */
-    addCommandAlias(keyArg, aliasArg) {
-        this.argv = this.argv.alias(keyArg, aliasArg);
-        return;
-    }
-    /**
-     * adds a Command by returning a Promise that reacts to the specific commandString given.
-     * Note: in e.g. "npm install something" the "install" is considered the command.
-     */
-    addCommand(commandNameArg) {
-        let triggerSubject = this.addTrigger(commandNameArg);
-        this.parseStarted.promise.then(() => {
-            if (this.argv._.indexOf(commandNameArg) === 0) {
-                this.trigger(commandNameArg);
-            }
-        });
-        return triggerSubject;
-    }
-    /**
-     * adds a Trigger. Like addCommand(), but returns an subscribable observable
-     */
-    addTrigger(triggerNameArg) {
-        let triggerSubject = new rxjs_1.Subject();
-        if (!this.getTriggerSubject(triggerNameArg)) {
-            this.allTriggerObservablesMap.add({
-                triggerName: triggerNameArg,
-                subject: triggerSubject
-            });
-        }
-        else {
-            throw new Error(`you can't add a trigger twice`);
-        }
-        return triggerSubject;
-    }
-    /**
-     * execute trigger by name
-     * @param commandNameArg - the name of the command to trigger
-     */
-    trigger(triggerName) {
-        let triggerSubject = this.getTriggerSubject(triggerName);
-        triggerSubject.next(this.argv);
-        return triggerSubject;
-    }
-    getTriggerSubject(triggerName) {
-        const triggerObservableObject = this.allTriggerObservablesMap.find(triggerObservableObjectArg => {
-            return triggerObservableObjectArg.triggerName === triggerName;
-        });
-        if (triggerObservableObject) {
-            return triggerObservableObject.subject;
-        }
-        else {
-            return null;
-        }
-    }
-    /**
-     * allows to specify help text to be printed above the rest of the help text
-     */
-    addHelp(optionsArg) {
-        this.addCommand('help').subscribe(argvArg => {
-            plugins.beautylog.log(optionsArg.helpText);
-        });
-    }
-    /**
-     * specify version to be printed for -v --version
-     */
-    addVersion(versionArg) {
-        this.version = versionArg;
-        this.addCommandAlias('v', 'version');
-        this.parseStarted.promise.then(() => {
-            if (this.argv.v) {
-                console.log(this.version);
-            }
-        });
-    }
-    /**
-     * adds a trigger that is called when no command is specified
-     */
-    standardTask() {
-        let standardSubject = this.addTrigger('standardTask');
-        this.parseStarted.promise.then(() => {
-            if (this.argv._.length === 0 && !this.argv.v) {
-                if (this.onlyOnProcessEnvCliCall) {
-                    if (process.env.CLI_CALL === 'true') {
-                        this.trigger('standardTask');
-                    }
-                    else {
-                        return;
-                    }
-                }
-                else {
-                    this.trigger('standardTask');
-                }
-            }
-        });
-        return standardSubject;
-    }
-    /**
-     * start the process of evaluating commands
-     */
-    startParse() {
-        this.argv = this.argv.argv;
-        this.parseStarted.resolve();
-        return;
-    }
-}
-exports.Smartcli = Smartcli;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxpQ0FBaUM7QUFDakMsK0JBQStCO0FBRS9CLDhDQUE4QztBQUU5QyxpQkFBaUI7QUFDakIsNkJBQWdDO0FBYWhDOztHQUVHO0FBQ0g7SUFjRTs7T0FFRztJQUNIO1FBVlEsNEJBQXVCLEdBQUcsS0FBSyxDQUFDO1FBRXhDOztXQUVHO1FBQ0gsNkJBQXdCLEdBQUcsSUFBSSxlQUFTLEVBQTRCLENBQUM7UUFNbkUsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDO1FBQzFCLElBQUksQ0FBQyxhQUFhLEdBQUcsTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3BDLElBQUksQ0FBQyxZQUFZLEdBQUcsTUFBTSxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ3JDLENBQUM7SUFFRDs7T0FFRztJQUNILDhCQUE4QjtRQUM1QixJQUFJLENBQUMsdUJBQXVCLEdBQUcsSUFBSSxDQUFDO0lBQ3RDLENBQUM7SUFFRDs7T0FFRztJQUNILGVBQWUsQ0FBQyxNQUFNLEVBQUUsUUFBUTtRQUM5QixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBRSxRQUFRLENBQUMsQ0FBQztRQUM5QyxPQUFPO0lBQ1QsQ0FBQztJQUVEOzs7T0FHRztJQUNILFVBQVUsQ0FBQyxjQUFzQjtRQUMvQixJQUFJLGNBQWMsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ3JELElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7WUFDbEMsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLEtBQUssQ0FBQyxFQUFFO2dCQUM3QyxJQUFJLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDO2FBQzlCO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFDSCxPQUFPLGNBQWMsQ0FBQztJQUN4QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVLENBQUMsY0FBc0I7UUFDL0IsSUFBSSxjQUFjLEdBQUcsSUFBSSxjQUFPLEVBQU8sQ0FBQztRQUN4QyxJQUFJLENBQUMsSUFBSSxDQUFDLGlCQUFpQixDQUFDLGNBQWMsQ0FBQyxFQUFFO1lBQzNDLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxHQUFHLENBQUM7Z0JBQ2hDLFdBQVcsRUFBRSxjQUFjO2dCQUMzQixPQUFPLEVBQUUsY0FBYzthQUN4QixDQUFDLENBQUM7U0FDSjthQUFNO1lBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQywrQkFBK0IsQ0FBQyxDQUFDO1NBQ2xEO1FBQ0QsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVEOzs7T0FHRztJQUNILE9BQU8sQ0FBQyxXQUFtQjtRQUN6QixJQUFJLGNBQWMsR0FBRyxJQUFJLENBQUMsaUJBQWlCLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDekQsY0FBYyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDL0IsT0FBTyxjQUFjLENBQUM7SUFDeEIsQ0FBQztJQUVELGlCQUFpQixDQUFDLFdBQW1CO1FBQ25DLE1BQU0sdUJBQXVCLEdBQUcsSUFBSSxDQUFDLHdCQUF3QixDQUFDLElBQUksQ0FDaEUsMEJBQTBCLENBQUMsRUFBRTtZQUMzQixPQUFPLDBCQUEwQixDQUFDLFdBQVcsS0FBSyxXQUFXLENBQUM7UUFDaEUsQ0FBQyxDQUNGLENBQUM7UUFDRixJQUFJLHVCQUF1QixFQUFFO1lBQzNCLE9BQU8sdUJBQXVCLENBQUMsT0FBTyxDQUFDO1NBQ3hDO2FBQU07WUFDTCxPQUFPLElBQUksQ0FBQztTQUNiO0lBQ0gsQ0FBQztJQUVEOztPQUVHO0lBQ0gsT0FBTyxDQUFDLFVBQWdDO1FBQ3RDLElBQUksQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxFQUFFO1lBQzFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUM3QyxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxVQUFrQjtRQUMzQixJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQztRQUMxQixJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBRSxTQUFTLENBQUMsQ0FBQztRQUNyQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFO1lBQ2xDLElBQUksSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUU7Z0JBQ2YsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7YUFDM0I7UUFDSCxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7T0FFRztJQUNILFlBQVk7UUFDVixJQUFJLGVBQWUsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1FBQ3RELElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUU7WUFDbEMsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUU7Z0JBQzVDLElBQUksSUFBSSxDQUFDLHVCQUF1QixFQUFFO29CQUNoQyxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxLQUFLLE1BQU0sRUFBRTt3QkFDbkMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxjQUFjLENBQUMsQ0FBQztxQkFDOUI7eUJBQU07d0JBQ0wsT0FBTztxQkFDUjtpQkFDRjtxQkFBTTtvQkFDTCxJQUFJLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDO2lCQUM5QjthQUNGO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFDSCxPQUFPLGVBQWUsQ0FBQztJQUN6QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ1IsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztRQUMzQixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQzVCLE9BQU87SUFDVCxDQUFDO0NBQ0Y7QUE5SUQsNEJBOElDIn0=

dist/smartcli.plugins.d.ts

@@ -1,6 +0,0 @@
-import * as yargs from 'yargs';
-import * as beautylog from 'beautylog';
-import * as lik from 'lik';
-import * as path from 'path';
-import * as smartparam from 'smartparam';
-export { yargs, beautylog, lik, path, smartparam };

dist/smartcli.plugins.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const yargs = require("yargs");
-exports.yargs = yargs;
-const beautylog = require("beautylog");
-exports.beautylog = beautylog;
-const lik = require("lik");
-exports.lik = lik;
-const path = require("path");
-exports.path = path;
-const smartparam = require("smartparam");
-exports.smartparam = smartparam;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwrQkFBK0I7QUFNdEIsc0JBQUs7QUFMZCx1Q0FBdUM7QUFLdkIsOEJBQVM7QUFKekIsMkJBQTJCO0FBSUEsa0JBQUc7QUFIOUIsNkJBQTZCO0FBR0csb0JBQUk7QUFGcEMseUNBQXlDO0FBRUgsZ0NBQVUifQ==

docs/index.md

@@ -23,45 +23,6 @@ nodejs wrapper for CLI related tasks
 
 ## Usage
 
-this plugin tries to establish some logic in which CLI tools work.
-
-take the following commandline input:
-
-```
-mytool command argument1 argument2 --option1 -o2 option2Value
-```
-
-- `mytool` obviously is the tool (like git)
-- `command` is the main thing the tool shall do (like commit)
-- `argument1` and `argument2` are arguments
-- `option1` is a longform option you can add (like --message for message)
-- `optionValue` is the referenced option value (like a commit message)
-
-When there is no command and no option specified the standardTask applied.
-When there is a option specified but no command, standardTask applies,
-except when of the options is -v, --version or --help.
-
-```javascript
-import { Smartcli } from 'smartcli';
-mySmartcli = new Smartcli();
-mySmartcli.standardTask().then(argvArg => {
-  // do something if program is called without an command
-});
-
-mySmartcli.addCommand({ commandname: 'install' }).then(argvArg => {
-  // do something if program is called with command "install"
-});
-
-mySmartcli.addVersion('1.0.0'); // -v and --version options will display the specified version in the terminal
-
-mySmartCli.addHelp({
-  // is triggered by help command and --help option
-  helpText: 'some help text to print' // the helpText to display
-});
-
-mySmartcli.startParse(); // starts the evaluation and fullfills or rejects promises.
-```
-
 For further information read the linked docs at the top of this README.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

npmextra.json

@@ -1,9 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts",
-      "ts-node"
-    ],
+    "npmGlobalTools": [],
     "npmAccesslevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartcli",
+      "description": "easy observable cli tasks",
+      "npmPackagename": "@pushrocks/smartcli",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pushrocks/smartcli",
   "private": false,
-  "version": "3.0.2",
-  "description": "nodejs wrapper for CLI related tasks",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "version": "4.0.5",
+  "description": "easy observable cli tasks",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
-    "build": "(npmts)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -26,23 +28,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "@types/yargs": "^11.0.0",
-    "beautylog": "^6.1.10",
-    "lik": "^2.0.5",
-    "rxjs": "^6.2.1",
-    "smartparam": "1.0.2",
-    "smartq": "^1.1.8",
-    "yargs": "^11.0.0"
+    "@pushrocks/lik": "^6.0.0",
+    "@pushrocks/smartlog": "^3.0.1",
+    "@pushrocks/smartparam": "^1.1.6",
+    "@pushrocks/smartpromise": "^3.1.3",
+    "@pushrocks/smartrx": "^2.0.25",
+    "yargs-parser": "21.0.1"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.0.7",
-    "@types/node": "^10.5.0",
-    "cz-conventional-changelog": "^2.1.0",
-    "tapbundle": "^2.0.2"
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.3"
   },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
-  }
+  "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,76 @@
+# @pushrocks/smartcli
+easy observable cli tasks
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartcli)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartcli)
+* [github.com (source mirror)](https://github.com/pushrocks/smartcli)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartcli/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartcli/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartcli/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartcli)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartcli)](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/smartcli)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartcli)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartcli)](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
+
+this plugin tries to establish some logic in which CLI tools work.
+
+take the following commandline input:
+
+```
+mytool command argument1 argument2 --option1 -o2 option2Value
+```
+
+- `mytool` obviously is the tool (like git)
+- `command` is the main thing the tool shall do (like commit)
+- `argument1` and `argument2` are arguments
+- `option1` is a longform option you can add (like --message for message)
+- `optionValue` is the referenced option value (like a commit message)
+
+When there is no command and no option specified the standardTask applied.
+When there is a option specified but no command, standardTask applies,
+except when of the options is -v, --version or --help.
+
+```javascript
+import { Smartcli } from 'smartcli';
+mySmartcli = new Smartcli();
+mySmartcli.standardTask().then((argvArg) => {
+  // do something if program is called without an command
+});
+
+mySmartcli.addCommand({ commandname: 'install' }).then((argvArg) => {
+  // do something if program is called with command "install"
+});
+
+mySmartcli.addVersion('1.0.0'); // -v and --version options will display the specified version in the terminal
+
+mySmartCli.addHelp({
+  // is triggered by help command and --help option
+  helpText: 'some help text to print', // the helpText to display
+});
+
+mySmartcli.startParse(); // starts the evaluation and fullfills or rejects promises.
+```
+
+## 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.ts

@@ -1,43 +1,42 @@
-import { tap, expect } from 'tapbundle';
+import { tap, expect } from '@pushrocks/tapbundle';
 import { Subject } from 'rxjs';
 
-import smartcli = require('../ts/index');
-
-let smartCliTestObject: smartcli.Smartcli;
+import * as smartcli from '../ts/index.js';
 
 tap.test('should create a new Smartcli', async () => {
-  smartCliTestObject = new smartcli.Smartcli();
-  expect(smartCliTestObject).to.be.instanceof(smartcli.Smartcli);
+  const smartCliTestObject = new smartcli.Smartcli();
+  expect(smartCliTestObject).toBeInstanceOf(smartcli.Smartcli);
 });
 
-tap.test('should add an command', async () => {
-  expect(smartCliTestObject.addCommand('awesome')).to.be.instanceOf(Subject);
+tap.test('should add an command', async (toolsArg) => {
+  const done = toolsArg.defer();
+  const smartCliTestObject = new smartcli.Smartcli();
+  const awesomeCommandSubject = smartCliTestObject.addCommand('awesome')
+  expect(awesomeCommandSubject).toBeInstanceOf(Subject);
+  awesomeCommandSubject.subscribe(() => {
+    done.resolve();
+  });
+  console.log(process.argv);
+  process.argv.splice(2, 0, 'awesome');
+  console.log(process.argv);
+  smartCliTestObject.startParse();
+  await done.promise;
 });
 
 tap.test('should start parsing a standardTask', async () => {
-  expect(smartCliTestObject.standardTask()).to.be.instanceOf(Subject);
+  const smartCliTestObject = new smartcli.Smartcli();
+  expect(smartCliTestObject.standardCommand()).toBeInstanceOf(Subject);
 });
 
 let hasExecuted: boolean = false;
 
 tap.test('should accept a command', async () => {
-  smartCliTestObject.addTrigger('triggerme').subscribe(() => {
+  const smartCliTestObject = new smartcli.Smartcli();
+  smartCliTestObject.addCommand('triggerme').subscribe(() => {
     hasExecuted = true;
   });
-});
-
-tap.test('should not have executed yet', async () => {
-  expect(hasExecuted).to.be.false;
-});
-
-tap.test('should execute when triggered', async () => {
-  smartCliTestObject.trigger('triggerme');
-  expect(hasExecuted).be.true;
-});
-
-tap.test('should start parsing the CLI input', async () => {
-  smartCliTestObject.startParse();
-  expect(smartCliTestObject.parseStarted.promise).to.be.instanceOf(Promise);
+  smartCliTestObject.triggerCommand('triggerme', {});
+  expect(hasExecuted).toBeTrue();
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartcli',
+  version: '4.0.5',
+  description: 'easy observable cli tasks'
+}

ts/index.ts

@@ -1 +1 @@
-export { Smartcli } from './smartcli.classes.smartcli';
+export { Smartcli } from './smartcli.classes.smartcli.js';

ts/smartcli.classes.smartcli.ts

@@ -1,107 +1,77 @@
-import * as smartq from 'smartq';
-import { Subject } from 'rxjs';
-
-import * as plugins from './smartcli.plugins';
-
-// import classes
-import { Objectmap } from 'lik';
+import * as plugins from './smartcli.plugins.js';
 
 // interfaces
-export interface ICommandPromiseObject {
+export interface ICommandObservableObject {
   commandName: string;
-  promise: Promise<void>;
+  subject: plugins.smartrx.rxjs.Subject<any>;
 }
 
-export interface ITriggerObservableObject {
-  triggerName: string;
-  subject: Subject<any>;
-}
+const logger = new plugins.smartlog.ConsoleLog();
 
 /**
  * class to create a new instance of Smartcli. Handles parsing of command line arguments.
  */
 export class Smartcli {
-  argv: any;
-  questionsDone;
-  parseStarted: smartq.Deferred<any>;
-  commands;
-  questions;
-  version: string;
-  private onlyOnProcessEnvCliCall = false;
+  /**
+   * this Deferred contains the parsed result in the end
+   */
+  public parseCompleted = plugins.smartpromise.defer<any>();
+
+  public version: string;
 
   /**
    * map of all Trigger/Observable objects to keep track
    */
-  allTriggerObservablesMap = new Objectmap<ITriggerObservableObject>();
+  private commandObservableMap = new plugins.lik.ObjectMap<ICommandObservableObject>();
+
+  /**
+   * maps alias
+   */
+  public aliasObject: { [key: string]: string[] } = {};
 
   /**
    * The constructor of Smartcli
    */
-  constructor() {
-    this.argv = plugins.yargs;
-    this.questionsDone = smartq.defer();
-    this.parseStarted = smartq.defer();
-  }
-
-  /**
-   * halts any execution of commands if (process.env.CLI_CALL === false)
-   */
-  onlyTriggerOnProcessEnvCliCall() {
-    this.onlyOnProcessEnvCliCall = true;
-  }
+  constructor() {}
 
   /**
    * adds an alias, meaning one equals the other in terms of command execution.
    */
-  addCommandAlias(keyArg, aliasArg): void {
-    this.argv = this.argv.alias(keyArg, aliasArg);
-    return;
+  public addCommandAlias(originalArg: string, aliasArg: string): void {
+    this.aliasObject[originalArg] = this.aliasObject[originalArg] || [];
+    this.aliasObject[originalArg].push(aliasArg);
   }
 
   /**
    * adds a Command by returning a Promise that reacts to the specific commandString given.
    * Note: in e.g. "npm install something" the "install" is considered the command.
    */
-  addCommand(commandNameArg: string): Subject<any> {
-    let triggerSubject = this.addTrigger(commandNameArg);
-    this.parseStarted.promise.then(() => {
-      if (this.argv._.indexOf(commandNameArg) === 0) {
-        this.trigger(commandNameArg);
-      }
-    });
-    return triggerSubject;
-  }
+  public addCommand(commandNameArg: string): plugins.smartrx.rxjs.Subject<any> {
+    let commandSubject: plugins.smartrx.rxjs.Subject<any>;
+    const existingCommandSubject = this.getCommandSubject(commandNameArg);
+    commandSubject = existingCommandSubject || new plugins.smartrx.rxjs.Subject<any>();
 
-  /**
-   * adds a Trigger. Like addCommand(), but returns an subscribable observable
-   */
-  addTrigger(triggerNameArg: string) {
-    let triggerSubject = new Subject<any>();
-    if (!this.getTriggerSubject(triggerNameArg)) {
-      this.allTriggerObservablesMap.add({
-        triggerName: triggerNameArg,
-        subject: triggerSubject
-      });
-    } else {
-      throw new Error(`you can't add a trigger twice`);
-    }
-    return triggerSubject;
+    this.commandObservableMap.add({
+      commandName: commandNameArg,
+      subject: commandSubject,
+    });
+    return commandSubject;
   }
 
   /**
    * execute trigger by name
    * @param commandNameArg - the name of the command to trigger
    */
-  trigger(triggerName: string) {
-    let triggerSubject = this.getTriggerSubject(triggerName);
-    triggerSubject.next(this.argv);
+  public triggerCommand(commandNameArg: string, argvObject: any) {
+    const triggerSubject = this.getCommandSubject(commandNameArg);
+    triggerSubject.next(argvObject);
     return triggerSubject;
   }
 
-  getTriggerSubject(triggerName: string) {
-    const triggerObservableObject = this.allTriggerObservablesMap.find(
-      triggerObservableObjectArg => {
-        return triggerObservableObjectArg.triggerName === triggerName;
+  public getCommandSubject(commandNameArg: string) {
+    const triggerObservableObject = this.commandObservableMap.findSync(
+      (triggerObservableObjectArg) => {
+        return triggerObservableObjectArg.commandName === commandNameArg;
       }
     );
     if (triggerObservableObject) {
@@ -114,52 +84,78 @@ export class Smartcli {
   /**
    * allows to specify help text to be printed above the rest of the help text
    */
-  addHelp(optionsArg: { helpText: string }) {
-    this.addCommand('help').subscribe(argvArg => {
-      plugins.beautylog.log(optionsArg.helpText);
+  public addHelp(optionsArg: { helpText: string }) {
+    this.addCommand('help').subscribe((argvArg) => {
+      logger.log('info', optionsArg.helpText);
     });
   }
 
   /**
    * specify version to be printed for -v --version
    */
-  addVersion(versionArg: string) {
+  public addVersion(versionArg: string) {
     this.version = versionArg;
-    this.addCommandAlias('v', 'version');
-    this.parseStarted.promise.then(() => {
-      if (this.argv.v) {
-        console.log(this.version);
-      }
-    });
   }
 
   /**
    * adds a trigger that is called when no command is specified
    */
-  standardTask(): Subject<any> {
-    let standardSubject = this.addTrigger('standardTask');
-    this.parseStarted.promise.then(() => {
-      if (this.argv._.length === 0 && !this.argv.v) {
-        if (this.onlyOnProcessEnvCliCall) {
-          if (process.env.CLI_CALL === 'true') {
-            this.trigger('standardTask');
-          } else {
-            return;
-          }
-        } else {
-          this.trigger('standardTask');
-        }
-      }
-    });
+  public standardCommand(): plugins.smartrx.rxjs.Subject<any> {
+    const standardSubject = this.addCommand('standardCommand');
     return standardSubject;
   }
 
   /**
    * start the process of evaluating commands
    */
-  startParse(): void {
-    this.argv = this.argv.argv;
-    this.parseStarted.resolve();
+  public startParse(): void {
+    const parsedYArgs = plugins.yargsParser(process.argv);
+
+    // lets handle commands
+    let counter = 0;
+    let foundCommand = false;
+    parsedYArgs._ = parsedYArgs._.filter((commandPartArg) => {
+      counter++;
+      if (typeof commandPartArg === 'number') {
+        return true;
+      }
+      if (counter <= 2 && !foundCommand) {
+        const isPath = commandPartArg.startsWith('/');
+        foundCommand = !isPath;
+        return foundCommand;
+      } else {
+        return true;
+      }
+    });
+    const wantedCommand = parsedYArgs._[0];
+
+    // lets handle some standards
+    if (!wantedCommand && (parsedYArgs.v || parsedYArgs.version)) {
+      console.log(this.version || 'unknown version');
+      return;
+    }
+
+    for (const command of this.commandObservableMap.getArray()) {
+      if (!wantedCommand) {
+        const standardCommand = this.commandObservableMap.findSync((commandArg) => {
+          return commandArg.commandName === 'standardCommand';
+        });
+        if (standardCommand) {
+          standardCommand.subject.next(parsedYArgs);
+        } else {
+          console.log('no smartcli standard task was created or assigned.');
+        }
+        break;
+      }
+      console.log(`Wanted command: ${wantedCommand}`);
+      if (command.commandName === parsedYArgs._[0]) {
+        command.subject.next(parsedYArgs);
+        break;
+      }
+      if (this.aliasObject[parsedYArgs[0]]) {
+      }
+    }
+    this.parseCompleted.resolve(parsedYArgs);
     return;
   }
 }

ts/smartcli.plugins.ts

@@ -1,7 +1,14 @@
-import * as yargs from 'yargs';
-import * as beautylog from 'beautylog';
-import * as lik from 'lik';
+// @pushrocks scope
+import * as smartlog from '@pushrocks/smartlog';
+import * as lik from '@pushrocks/lik';
 import * as path from 'path';
-import * as smartparam from 'smartparam';
+import * as smartparam from '@pushrocks/smartparam';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 
-export { yargs, beautylog, lik, path, smartparam };
+export { smartlog, lik, path, smartparam, smartpromise, smartrx };
+
+// thirdparty scope
+import yargsParser from 'yargs-parser';
+
+export { yargsParser };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}