3.0.6

.gitlab-ci.yml

@@ -117,8 +117,9 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g typedoc typescript
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv

.snyk

@@ -0,0 +1,9 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.12.0
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  'npm:mem:20180117':
+    - yargs > os-locale > mem:
+        reason: None given
+        expires: '2018-09-29T22:12:38.004Z'
+patch: {}

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==

npmextra.json

@@ -1,9 +1,6 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts",
-      "ts-node"
-    ],
+    "npmGlobalTools": [],
     "npmAccesslevel": "public"
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartcli",
   "private": false,
-  "version": "3.0.2",
+  "version": "3.0.6",
   "description": "nodejs wrapper for CLI related tasks",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
-    "build": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -26,23 +26,19 @@
   },
   "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": "^3.0.1",
+    "@pushrocks/smartlog": "^2.0.1",
+    "@pushrocks/smartparam": "^1.0.4",
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@types/yargs": "^11.1.1",
+    "rxjs": "^6.3.2",
+    "yargs": "^12.0.2"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.0.7",
-    "@types/node": "^10.5.0",
-    "cz-conventional-changelog": "^2.1.0",
-    "tapbundle": "^2.0.2"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
-    }
+    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^10.9.4"
   }
 }

test/test.ts

@@ -1,4 +1,4 @@
-import { tap, expect } from 'tapbundle';
+import { tap, expect } from '@pushrocks/tapbundle';
 import { Subject } from 'rxjs';
 
 import smartcli = require('../ts/index');

ts/smartcli.classes.smartcli.ts

@@ -1,10 +1,10 @@
-import * as smartq from 'smartq';
+import * as smartpromise from '@pushrocks/smartpromise';
 import { Subject } from 'rxjs';
 
 import * as plugins from './smartcli.plugins';
 
 // import classes
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 
 // interfaces
 export interface ICommandPromiseObject {
@@ -23,7 +23,7 @@ export interface ITriggerObservableObject {
 export class Smartcli {
   argv: any;
   questionsDone;
-  parseStarted: smartq.Deferred<any>;
+  parseStarted: smartpromise.Deferred<any>;
   commands;
   questions;
   version: string;
@@ -39,8 +39,8 @@ export class Smartcli {
    */
   constructor() {
     this.argv = plugins.yargs;
-    this.questionsDone = smartq.defer();
-    this.parseStarted = smartq.defer();
+    this.questionsDone = smartpromise.defer();
+    this.parseStarted = smartpromise.defer();
   }
 
   /**
@@ -116,7 +116,7 @@ export class Smartcli {
    */
   addHelp(optionsArg: { helpText: string }) {
     this.addCommand('help').subscribe(argvArg => {
-      plugins.beautylog.log(optionsArg.helpText);
+      plugins.smartlog.defaultLogger.info(optionsArg.helpText);
     });
   }
 

ts/smartcli.plugins.ts

@@ -1,7 +1,7 @@
 import * as yargs from 'yargs';
-import * as beautylog from 'beautylog';
-import * as lik from 'lik';
+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';
 
-export { yargs, beautylog, lik, path, smartparam };
+export { yargs, smartlog, lik, path, smartparam };