2.0.0

README.md

@@ -26,16 +26,20 @@ this plugin tries to establish some logic in which CLI tools work.
 take the following commandline input:
 
 ```
-mytool function argument1 argument2 --option1 -o2 option2Value
+mytool command argument1 argument2 --option1 -o2 option2Value
 ```
 
-* 'mytool' obviously is the tool (like git)
+* `mytool` obviously is the tool (like git)
-* function is the main thing the tool shall do (like commit)
+* `command` is the main thing the tool shall do (like commit)
-* argument1 and argument2 are arguments
+* `argument1` and `argument2` are arguments
-* option1 is a longform option you can add (like --message for message)
+* `option1` is a longform option you can add (like --message for message)
-* optionValue is the referenced option value (like a commit message)
+* `optionValue` is the referenced option value (like a commit message)
 
-```typescript
+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()
@@ -47,6 +51,14 @@ 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.
 ```
 
 [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/smartcli.classes.smartcli.d.ts

@@ -1,9 +1,14 @@
 /// <reference types="q" />
 import * as q from 'q';
+import { Subject } from 'rxjs';
 import { Objectmap } from 'lik';
 export interface ICommandPromiseObject {
     commandName: string;
-    promise: q.Promise<any>;
+    promise: q.Promise<void>;
+}
+export interface ITriggerObservableObject {
+    triggerName: string;
+    subject: Subject<void>;
 }
 export declare class Smartcli {
     argv: any;
@@ -12,23 +17,37 @@ export declare class Smartcli {
     commands: any;
     questions: any;
     version: string;
-    allCommandPromises: Objectmap<ICommandPromiseObject>;
+    /**
+     * map of all Command/Promise objects to keep track
+     */
+    allCommandPromisesMap: Objectmap<ICommandPromiseObject>;
+    /**
+     * map of all Trigger/Observable objects to keep track
+     */
+    allTriggerObservablesMap: Objectmap<ITriggerObservableObject>;
     constructor();
     /**
-     * adds an alias, meaning one equals the other in terms of triggering associated commands
+     * adds an alias, meaning one equals the other in terms of command execution.
      */
-    addAlias(keyArg: any, aliasArg: any): void;
+    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(definitionArg: {
+    addCommand(commandNameArg: string): q.Promise<any>;
-        commandName: string;
-    }): q.Promise<any>;
     /**
      * gets a Promise for a command word
      */
-    getCommandPromiseByName(commandNameArg: string): q.Promise<any>;
+    getCommandPromiseByName(commandNameArg: string): q.Promise<void>;
+    /**
+     * adds a Trigger. Like addCommand(), but returns an subscribable observable
+     */
+    addTrigger(triggerNameArg: string): Subject<void>;
+    /**
+     * execute trigger by name
+     * @param commandNameArg - the name of the command to trigger
+     */
+    trigger(triggerName: string): Subject<void>;
     /**
      * allows to specify help text to be printed above the rest of the help text
      */

dist/smartcli.classes.smartcli.js

@@ -1,20 +1,27 @@
 "use strict";
 const q = require("q");
+const rxjs_1 = require("rxjs");
 const plugins = require("./smartcli.plugins");
 // import classes
 const lik_1 = require("lik");
 class Smartcli {
     constructor() {
-        // maps
+        /**
-        this.allCommandPromises = new lik_1.Objectmap();
+         * map of all Command/Promise objects to keep track
+         */
+        this.allCommandPromisesMap = new lik_1.Objectmap();
+        /**
+         * map of all Trigger/Observable objects to keep track
+         */
+        this.allTriggerObservablesMap = new lik_1.Objectmap();
         this.argv = plugins.yargs;
         this.questionsDone = q.defer();
         this.parseStarted = q.defer();
     }
     /**
-     * adds an alias, meaning one equals the other in terms of triggering associated commands
+     * adds an alias, meaning one equals the other in terms of command execution.
      */
-    addAlias(keyArg, aliasArg) {
+    addCommandAlias(keyArg, aliasArg) {
         this.argv = this.argv.alias(keyArg, aliasArg);
         return;
     }
@@ -22,11 +29,15 @@ class Smartcli {
      * 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(definitionArg) {
+    addCommand(commandNameArg) {
         let done = q.defer();
+        this.allCommandPromisesMap.add({
+            commandName: commandNameArg,
+            promise: done.promise
+        });
         this.parseStarted.promise
             .then(() => {
-            if (this.argv._.indexOf(definitionArg.commandName) === 0) {
+            if (this.argv._.indexOf(commandNameArg) === 0) {
                 done.resolve(this.argv);
             }
             else {
@@ -39,17 +50,40 @@ class Smartcli {
      * gets a Promise for a command word
      */
     getCommandPromiseByName(commandNameArg) {
-        return this.allCommandPromises.find(commandPromiseObjectArg => {
+        return this.allCommandPromisesMap.find(commandDeferredObjectArg => {
-            return commandPromiseObjectArg.commandName === commandNameArg;
+            return commandDeferredObjectArg.commandName === commandNameArg;
         }).promise;
     }
+    /**
+     * adds a Trigger. Like addCommand(), but returns an subscribable observable
+     */
+    addTrigger(triggerNameArg) {
+        let triggerSubject = new rxjs_1.Subject();
+        this.allTriggerObservablesMap.add({
+            triggerName: triggerNameArg,
+            subject: triggerSubject
+        });
+        this.addCommand(triggerNameArg).then(() => {
+            triggerSubject.next();
+        });
+        return triggerSubject;
+    }
+    /**
+     * execute trigger by name
+     * @param commandNameArg - the name of the command to trigger
+     */
+    trigger(triggerName) {
+        let triggerSubject = this.allTriggerObservablesMap.find(triggerObservableObjectArg => {
+            return triggerObservableObjectArg.triggerName === triggerName;
+        }).subject;
+        triggerSubject.next();
+        return triggerSubject;
+    }
     /**
      * allows to specify help text to be printed above the rest of the help text
      */
     addHelp(optionsArg) {
-        this.addCommand({
+        this.addCommand('help').then(argvArg => {
-            commandName: 'help'
-        }).then(argvArg => {
             plugins.beautylog.log(optionsArg.helpText);
         });
     }
@@ -58,7 +92,7 @@ class Smartcli {
      */
     addVersion(versionArg) {
         this.version = versionArg;
-        this.addAlias('v', 'version');
+        this.addCommandAlias('v', 'version');
         this.parseStarted.promise
             .then(() => {
             if (this.argv.v) {
@@ -71,6 +105,10 @@ class Smartcli {
      */
     standardTask() {
         let done = q.defer();
+        this.allCommandPromisesMap.add({
+            commandName: 'standard',
+            promise: done.promise
+        });
         this.parseStarted.promise
             .then(() => {
             if (this.argv._.length === 0 && !this.argv.v) {
@@ -92,4 +130,4 @@ class Smartcli {
     }
 }
 exports.Smartcli = Smartcli;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHVCQUFzQjtBQUV0Qiw4Q0FBNkM7QUFFN0MsaUJBQWlCO0FBQ2pCLDZCQUE2QjtBQVE3QjtJQVVJO1FBRkEsT0FBTztRQUNQLHVCQUFrQixHQUFHLElBQUksZUFBUyxFQUF5QixDQUFBO1FBRXZELElBQUksQ0FBQyxJQUFJLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQTtRQUN6QixJQUFJLENBQUMsYUFBYSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUM5QixJQUFJLENBQUMsWUFBWSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUNqQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxRQUFRLENBQUMsTUFBTSxFQUFDLFFBQVE7UUFDcEIsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEVBQUMsUUFBUSxDQUFDLENBQUE7UUFDNUMsTUFBTSxDQUFBO0lBQ1YsQ0FBQztJQUVEOzs7T0FHRztJQUNILFVBQVUsQ0FBQyxhQUFvQztRQUMzQyxJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFPLENBQUE7UUFDekIsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPO2FBQ3BCLElBQUksQ0FBQztZQUNGLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxhQUFhLENBQUMsV0FBVyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztnQkFDdkQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDM0IsQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQzFCLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtRQUNOLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILHVCQUF1QixDQUFDLGNBQXNCO1FBQzFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLHVCQUF1QjtZQUN2RCxNQUFNLENBQUMsdUJBQXVCLENBQUMsV0FBVyxLQUFLLGNBQWMsQ0FBQTtRQUNqRSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUE7SUFDZCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPLENBQUMsVUFFUDtRQUNHLElBQUksQ0FBQyxVQUFVLENBQUM7WUFDWixXQUFXLEVBQUUsTUFBTTtTQUN0QixDQUFDLENBQUMsSUFBSSxDQUFDLE9BQU87WUFDWCxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDOUMsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVLENBQUMsVUFBa0I7UUFDekIsSUFBSSxDQUFDLE9BQU8sR0FBRyxVQUFVLENBQUE7UUFDekIsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLEVBQUMsU0FBUyxDQUFDLENBQUE7UUFDNUIsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPO2FBQ3BCLElBQUksQ0FBQztZQUNGLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztnQkFDZCxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQTtZQUM3QixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7SUFDVixDQUFDO0lBRUQ7O09BRUc7SUFDSCxZQUFZO1FBQ1IsSUFBSSxJQUFJLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBTyxDQUFBO1FBQ3pCLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTzthQUNwQixJQUFJLENBQUM7WUFDRixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUMzQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtZQUMzQixDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDMUIsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ04sTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsVUFBVTtRQUNOLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUE7UUFDMUIsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUMzQixNQUFNLENBQUE7SUFDVixDQUFDO0NBRUo7QUF0R0QsNEJBc0dDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHVCQUFzQjtBQUN0QiwrQkFBOEI7QUFFOUIsOENBQTZDO0FBRTdDLGlCQUFpQjtBQUNqQiw2QkFBK0I7QUFhL0I7SUFrQkk7UUFWQTs7V0FFRztRQUNILDBCQUFxQixHQUFHLElBQUksZUFBUyxFQUF5QixDQUFBO1FBRTlEOztXQUVHO1FBQ0gsNkJBQXdCLEdBQUcsSUFBSSxlQUFTLEVBQTRCLENBQUE7UUFHaEUsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFBO1FBQ3pCLElBQUksQ0FBQyxhQUFhLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzlCLElBQUksQ0FBQyxZQUFZLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQ2pDLENBQUM7SUFFRDs7T0FFRztJQUNILGVBQWUsQ0FBQyxNQUFNLEVBQUMsUUFBUTtRQUMzQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBQyxRQUFRLENBQUMsQ0FBQTtRQUM1QyxNQUFNLENBQUE7SUFDVixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsVUFBVSxDQUFDLGNBQXNCO1FBQzdCLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQU8sQ0FBQTtRQUN6QixJQUFJLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDO1lBQzNCLFdBQVcsRUFBRSxjQUFjO1lBQzNCLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztTQUN4QixDQUFDLENBQUE7UUFDRixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQzNCLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDSixJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtZQUMxQixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7UUFDTixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCx1QkFBdUIsQ0FBQyxjQUFzQjtRQUMxQyxNQUFNLENBQUMsSUFBSSxDQUFDLHFCQUFxQixDQUFDLElBQUksQ0FBQyx3QkFBd0I7WUFDM0QsTUFBTSxDQUFDLHdCQUF3QixDQUFDLFdBQVcsS0FBSyxjQUFjLENBQUE7UUFDbEUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFBO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0gsVUFBVSxDQUFDLGNBQXNCO1FBQzdCLElBQUksY0FBYyxHQUFHLElBQUksY0FBTyxFQUFRLENBQUE7UUFDeEMsSUFBSSxDQUFDLHdCQUF3QixDQUFDLEdBQUcsQ0FBQztZQUM5QixXQUFXLEVBQUUsY0FBYztZQUMzQixPQUFPLEVBQUUsY0FBYztTQUMxQixDQUFDLENBQUE7UUFDRixJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUNqQyxjQUFjLENBQUMsSUFBSSxFQUFFLENBQUE7UUFDekIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsY0FBYyxDQUFBO0lBQ3pCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxPQUFPLENBQUMsV0FBbUI7UUFDdkIsSUFBSSxjQUFjLEdBQUcsSUFBSSxDQUFDLHdCQUF3QixDQUFDLElBQUksQ0FBQywwQkFBMEI7WUFDOUUsTUFBTSxDQUFDLDBCQUEwQixDQUFDLFdBQVcsS0FBSyxXQUFXLENBQUE7UUFDakUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFBO1FBQ1YsY0FBYyxDQUFDLElBQUksRUFBRSxDQUFBO1FBQ3JCLE1BQU0sQ0FBQyxjQUFjLENBQUE7SUFDekIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsT0FBTyxDQUFDLFVBRVA7UUFDRyxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPO1lBQ2hDLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUM5QyxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxVQUFrQjtRQUN6QixJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQTtRQUN6QixJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBQyxTQUFTLENBQUMsQ0FBQTtRQUNuQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNkLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFBO1lBQzdCLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtJQUNWLENBQUM7SUFFRDs7T0FFRztJQUNILFlBQVk7UUFDUixJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFPLENBQUE7UUFDekIsSUFBSSxDQUFDLHFCQUFxQixDQUFDLEdBQUcsQ0FBQztZQUMzQixXQUFXLEVBQUUsVUFBVTtZQUN2QixPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87U0FDeEIsQ0FBQyxDQUFBO1FBQ0YsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPO2FBQ3BCLElBQUksQ0FBQztZQUNGLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLE1BQU0sS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzNDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQzNCLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDSixJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtZQUMxQixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7UUFDTixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ04sSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQTtRQUMxQixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQzNCLE1BQU0sQ0FBQTtJQUNWLENBQUM7Q0FFSjtBQS9JRCw0QkErSUMifQ==

dist/smartcli.plugins.js

@@ -10,4 +10,4 @@ const path = require("path");
 exports.path = path;
 const smartparam = require("smartparam");
 exports.smartparam = smartparam;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF3QjtBQUV4QiwrQkFBOEI7QUFPMUIsc0JBQUs7QUFOVCx1Q0FBc0M7QUFPbEMsOEJBQVM7QUFOYiwyQkFBMEI7QUFPdEIsa0JBQUc7QUFOUCw2QkFBNEI7QUFPeEIsb0JBQUk7QUFOUix5Q0FBd0M7QUFPcEMsZ0NBQVUifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUV2QiwrQkFBOEI7QUFPMUIsc0JBQUs7QUFOVCx1Q0FBc0M7QUFPbEMsOEJBQVM7QUFOYiwyQkFBMEI7QUFPdEIsa0JBQUc7QUFOUCw2QkFBNEI7QUFPeEIsb0JBQUk7QUFOUix5Q0FBd0M7QUFPcEMsZ0NBQVUifQ==

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartcli",
-  "version": "1.0.13",
+  "version": "2.0.0",
   "description": "nodejs wrapper for CLI related tasks",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -17,11 +17,12 @@
     "url": "https://gitlab.com/pushrocks/smartcli.git"
   },
   "keywords": [
-    "json",
+    "cli",
-    "jade",
+    "promise",
-    "template"
+    "task",
+    "push.rocks"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
     "url": "https://gitlab.com/pushrocks/smartcli/issues"
@@ -33,6 +34,7 @@
     "beautylog": "^6.0.0",
     "lik": "^1.0.24",
     "q": "^1.4.1",
+    "rxjs": "^5.0.1",
     "smartparam": "0.1.1",
     "typings-global": "^1.0.14",
     "yargs": "^6.4.0"

test/test.js

@@ -12,9 +12,7 @@ describe('smartcli.Smartcli class', function () {
     });
     describe('.addCommand', function () {
         it('should add an command', function () {
-            smartCliTestObject.addCommand({
+            smartCliTestObject.addCommand('awesome');
-                commandName: 'awesome'
-            });
         });
     });
     describe('.standardTask', function () {
@@ -26,10 +24,28 @@ describe('smartcli.Smartcli class', function () {
             done();
         });
     });
+    describe('.trigger', function () {
+        let hasExecuted = false;
+        it('should accept a command', function (done) {
+            smartCliTestObject.addTrigger('triggerme')
+                .subscribe(() => {
+                hasExecuted = true;
+            });
+            done();
+        });
+        it('should not have executed yet', function () {
+            should(hasExecuted).be.false();
+        });
+        it('should execute when triggered', function (done) {
+            smartCliTestObject.trigger('triggerme');
+            should(hasExecuted).be.true();
+            done();
+        });
+    });
     describe('.startParse', function () {
         it('should start parsing the CLI input', function () {
             smartCliTestObject.startParse();
         });
     });
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQiwwQ0FBMEM7QUFDMUMsaUNBQWdDO0FBRWhDLFFBQVEsQ0FBQyx5QkFBeUIsRUFBQztJQUMvQixJQUFJLGtCQUFxQyxDQUFBO0lBQ3pDLFFBQVEsQ0FBQyxnQkFBZ0IsRUFBQztRQUN0QixFQUFFLENBQUMsOEJBQThCLEVBQUM7WUFDOUIsa0JBQWtCLEdBQUcsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUE7WUFDNUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDL0QsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxhQUFhLEVBQUM7UUFDbkIsRUFBRSxDQUFDLHVCQUF1QixFQUFDO1lBQ3ZCLGtCQUFrQixDQUFDLFVBQVUsQ0FBQztnQkFDMUIsV0FBVyxFQUFFLFNBQVM7YUFDekIsQ0FBQyxDQUFBO1FBQ04sQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxlQUFlLEVBQUM7UUFDckIsRUFBRSxDQUFDLHFDQUFxQyxFQUFDLFVBQVMsSUFBSTtZQUNsRCxrQkFBa0IsQ0FBQyxZQUFZLEVBQUU7aUJBQzVCLElBQUksQ0FBQztnQkFDRixPQUFPLENBQUMsR0FBRyxDQUFDLDRCQUE0QixDQUFDLENBQUE7WUFDN0MsQ0FBQyxDQUFDLENBQUE7WUFDTixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7SUFDRixRQUFRLENBQUMsYUFBYSxFQUFDO1FBQ25CLEVBQUUsQ0FBQyxvQ0FBb0MsRUFBQztZQUNwQyxrQkFBa0IsQ0FBQyxVQUFVLEVBQUUsQ0FBQTtRQUNuQyxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQiwwQ0FBMEM7QUFDMUMsaUNBQWdDO0FBRWhDLFFBQVEsQ0FBQyx5QkFBeUIsRUFBQztJQUMvQixJQUFJLGtCQUFxQyxDQUFBO0lBQ3pDLFFBQVEsQ0FBQyxnQkFBZ0IsRUFBQztRQUN0QixFQUFFLENBQUMsOEJBQThCLEVBQUM7WUFDOUIsa0JBQWtCLEdBQUcsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUE7WUFDNUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDL0QsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxhQUFhLEVBQUM7UUFDbkIsRUFBRSxDQUFDLHVCQUF1QixFQUFDO1lBQ3ZCLGtCQUFrQixDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQTtRQUM1QyxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0lBQ0YsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixFQUFFLENBQUMscUNBQXFDLEVBQUMsVUFBUyxJQUFJO1lBQ2xELGtCQUFrQixDQUFDLFlBQVksRUFBRTtpQkFDNUIsSUFBSSxDQUFDO2dCQUNGLE9BQU8sQ0FBQyxHQUFHLENBQUMsNEJBQTRCLENBQUMsQ0FBQTtZQUM3QyxDQUFDLENBQUMsQ0FBQTtZQUNOLElBQUksRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxVQUFVLEVBQUU7UUFDakIsSUFBSSxXQUFXLEdBQUcsS0FBSyxDQUFBO1FBQ3ZCLEVBQUUsQ0FBQyx5QkFBeUIsRUFBRSxVQUFTLElBQUk7WUFDdkMsa0JBQWtCLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQztpQkFDckMsU0FBUyxDQUFDO2dCQUNQLFdBQVcsR0FBRyxJQUFJLENBQUE7WUFDdEIsQ0FBQyxDQUFDLENBQUE7WUFDTixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsRUFBRSxDQUFDLDhCQUE4QixFQUFFO1lBQy9CLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDbEMsQ0FBQyxDQUFDLENBQUE7UUFDRixFQUFFLENBQUMsK0JBQStCLEVBQUUsVUFBUyxJQUFJO1lBQzdDLGtCQUFrQixDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUN2QyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFBO1lBQzdCLElBQUksRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxhQUFhLEVBQUM7UUFDbkIsRUFBRSxDQUFDLG9DQUFvQyxFQUFDO1lBQ3BDLGtCQUFrQixDQUFDLFVBQVUsRUFBRSxDQUFBO1FBQ25DLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQSJ9

test/test.ts

@@ -13,9 +13,7 @@ describe('smartcli.Smartcli class',function(){
     })
     describe('.addCommand',function(){
         it('should add an command',function(){
-            smartCliTestObject.addCommand({
+            smartCliTestObject.addCommand('awesome')
-                commandName: 'awesome'
-            })
         })
     })
     describe('.standardTask',function(){
@@ -27,6 +25,24 @@ describe('smartcli.Smartcli class',function(){
             done()
         })
     })
+    describe('.trigger', function() {
+        let hasExecuted = false
+        it('should accept a command', function(done) {
+            smartCliTestObject.addTrigger('triggerme')
+                .subscribe(() => {
+                    hasExecuted = true
+                })
+            done()
+        })
+        it('should not have executed yet', function() {
+            should(hasExecuted).be.false()
+        })
+        it('should execute when triggered', function(done) {
+            smartCliTestObject.trigger('triggerme')
+            should(hasExecuted).be.true()
+            done()
+        })
+    })
     describe('.startParse',function(){
         it('should start parsing the CLI input',function(){
             smartCliTestObject.startParse()

ts/smartcli.classes.smartcli.ts

@@ -1,14 +1,20 @@
 import * as q from 'q'
+import { Subject } from 'rxjs'
 
 import * as plugins from './smartcli.plugins'
 
 // import classes
-import {Objectmap} from 'lik'
+import { Objectmap } from 'lik'
 
 // interfaces
 export interface ICommandPromiseObject {
-    commandName: string
+    commandName: string,
-    promise: q.Promise<any>
+    promise: q.Promise<void>
+}
+
+export interface ITriggerObservableObject {
+    triggerName: string
+    subject: Subject<void>
 }
 
 export class Smartcli {
@@ -19,8 +25,16 @@ export class Smartcli {
     questions
     version: string
 
-    // maps
+    /**
-    allCommandPromises = new Objectmap<ICommandPromiseObject>()
+     * map of all Command/Promise objects to keep track
+     */
+    allCommandPromisesMap = new Objectmap<ICommandPromiseObject>()
+
+    /**
+     * map of all Trigger/Observable objects to keep track
+     */
+    allTriggerObservablesMap = new Objectmap<ITriggerObservableObject>()
+
     constructor() {
         this.argv = plugins.yargs
         this.questionsDone = q.defer()
@@ -28,9 +42,9 @@ export class Smartcli {
     }
 
     /**
-     * adds an alias, meaning one equals the other in terms of triggering associated commands
+     * adds an alias, meaning one equals the other in terms of command execution.
      */
-    addAlias(keyArg,aliasArg): void {
+    addCommandAlias(keyArg,aliasArg): void {
         this.argv = this.argv.alias(keyArg,aliasArg)
         return
     }
@@ -39,11 +53,15 @@ export class Smartcli {
      * 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(definitionArg: {commandName: string}): q.Promise<any> {
+    addCommand(commandNameArg: string): q.Promise<any> {
         let done = q.defer<any>()
+        this.allCommandPromisesMap.add({
+            commandName: commandNameArg,
+            promise: done.promise
+        })
         this.parseStarted.promise
             .then(() => {
-                if (this.argv._.indexOf(definitionArg.commandName) === 0) {
+                if (this.argv._.indexOf(commandNameArg) === 0) {
                     done.resolve(this.argv)
                 } else {
                     done.reject(this.argv)
@@ -55,21 +73,46 @@ export class Smartcli {
     /**
      * gets a Promise for a command word
      */
-    getCommandPromiseByName(commandNameArg: string) {
+    getCommandPromiseByName(commandNameArg: string): q.Promise<void> {
-        return this.allCommandPromises.find(commandPromiseObjectArg => {
+        return this.allCommandPromisesMap.find(commandDeferredObjectArg => {
-            return commandPromiseObjectArg.commandName === commandNameArg
+            return commandDeferredObjectArg.commandName === commandNameArg
         }).promise
     }
 
+    /**
+     * adds a Trigger. Like addCommand(), but returns an subscribable observable 
+     */
+    addTrigger(triggerNameArg: string) {
+        let triggerSubject = new Subject<void>()
+        this.allTriggerObservablesMap.add({
+            triggerName: triggerNameArg,
+            subject: triggerSubject
+        })
+        this.addCommand(triggerNameArg).then(() => {
+            triggerSubject.next()
+        })
+        return triggerSubject
+    }
+
+    /**
+     * execute trigger by name
+     * @param commandNameArg - the name of the command to trigger
+     */
+    trigger(triggerName: string) {
+        let triggerSubject = this.allTriggerObservablesMap.find(triggerObservableObjectArg => {
+            return triggerObservableObjectArg.triggerName === triggerName
+        }).subject
+        triggerSubject.next()
+        return triggerSubject
+    }
+
     /**
      * allows to specify help text to be printed above the rest of the help text
      */
     addHelp(optionsArg: {
         helpText: string
     }) {
-        this.addCommand({
+        this.addCommand('help').then(argvArg => {
-            commandName: 'help'
-        }).then(argvArg => {
             plugins.beautylog.log(optionsArg.helpText)
         })
     }
@@ -79,7 +122,7 @@ export class Smartcli {
      */
     addVersion(versionArg: string) {
         this.version = versionArg
-        this.addAlias('v','version')
+        this.addCommandAlias('v','version')
         this.parseStarted.promise
             .then(() => {
                 if (this.argv.v) {
@@ -93,6 +136,10 @@ export class Smartcli {
      */
     standardTask(): q.Promise<any> {
         let done = q.defer<any>()
+        this.allCommandPromisesMap.add({
+            commandName: 'standard',
+            promise: done.promise
+        })
         this.parseStarted.promise
             .then(() => {
                 if (this.argv._.length === 0 && !this.argv.v) {

ts/smartcli.plugins.ts

@@ -1,4 +1,4 @@
-import 'typings-global';
+import 'typings-global'
 
 import * as yargs from 'yargs'
 import * as beautylog from 'beautylog'