2.0.0

Update beautylog to version 0.0.15 🚀

.gitignore

@@ -1,6 +1,9 @@
 node_modules/
-.settings/
-.idea/
+coverage/
+pages/
+
 
 ts/*.js
 ts/*.js.map
+ts/typings/
+

.gitlab-ci.yml

@@ -0,0 +1,50 @@
+image: hosttoday/ht-docker-node:npmts
+
+stages:
+- test
+- release
+- page
+
+testLEGACY:
+  stage: test
+  script:
+    - npmci test legacy
+  tags:
+    - docker
+  allow_failure: true
+
+testLTS:
+  stage: test
+  script:
+    - npmci test lts
+  tags:
+    - docker
+    
+testSTABLE:
+  stage: test
+  script:
+    - npmci test stable
+  tags:
+    - docker
+
+release:
+  stage: release
+  script:
+    - npmci publish
+  only:
+    - tags
+  tags:
+    - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: page
+  script:
+    - npmci test stable
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.travis.yml

@@ -1,19 +0,0 @@
-language: node_js
-before_install:
-- nvm install stable
-- node -v
-- npm -v
-- npm install -g gulp
-- npm install gulp
-- npm install gulp-typescript
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: XAtA2XHAr96ILKpm1VnB/Nff9hiQv3FUa/NDfGZgvJKimuF/TwU2+kXyAag/LlEQGckZ9/IDx0PTIe8x4wOvg2VyKceYktGt6G5/MHeAXwzkkM253k2CKweVtBgnpZ2doTZXeeV/h7hHuEWZbWRXIVCgM6/inaaNe4cMRGCWqwb1xmw6D8VkLpNo6PiB37gR4GfMokasgVHZEVMg2evWKk0moREGW9XKqoE6PS9TPHPHerdqFqfbmeOq3nNgHrJZkNsAJ3PPESWCe/NGEBwtYDKrPI3QlouvXmxScI9/p2VCQmdFoUxKMDsVzBdRMrCx+XxoS8x81HxubZSpnvzUlzGtznZi7e6OyAlI7xXELIO551AH4V/pNWWUPATX+7vXVDGh7aAZYme/fejisjO5Tk9aqRvohh2jCDml3ED6alHHfI0oX5UvBpOE+XwGTIJ8qpf9RrLP5DC27JWE3fqY/WoqIZX7phoKeKYLl+R7Iln/dfvepbMBgcesnBf4PuMh3Qm2l2G1bElJ/hniV1dgggwjcg50nA0Ee9sCnORPxxjdDIMwJw//NJSe+Aq5Fm1ure9oNiBYOeF0bLVQyfGIC8J8coy1xdqv2klKnGHjMMN44bjNlmDp00SaRpbdDuavyocosQVpzfA+hY2QtGV5TXFv6TLgcMYwf8gNyVNkSGE=
-  on:
-    tags: true
-    repo: pushrocks/smartcli
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

README.md

@@ -1,16 +1,64 @@
 # smartcli
-nodejs wrapper for CLI related tasks
+nodejs wrapper for CLI related tasks. TypeScript ready.
 
-### Buildstatus/Dependencies
-[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
-[![devDependency Status](https://david-dm.org/pushrocks/smartcli/dev-status.svg)](https://david-dm.org/pushrocks/smartcli#info=devDependencies)
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartcli)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartcli)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartcli)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartcli/docs)
 
-### Usage
-This npm package comes with everything you need to start your own gulp plugin.
+## 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)
+[![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/)
 
-We recommend modifying the ts/index.ts file, 
-then run `npm install` to install the dev dependencies
-and use `npm test` to compile the TypeScript file.
- 
-Cheers  
-Phil from Lossless Digital
+## Install the package
+    npm install smartcli --save
+
+## 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.
+```
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

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

dist/index.js

@@ -0,0 +1,4 @@
+"use strict";
+var smartcli_classes_smartcli_1 = require("./smartcli.classes.smartcli");
+exports.Smartcli = smartcli_classes_smartcli_1.Smartcli;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEseUVBQXNEO0FBQTdDLCtDQUFBLFFBQVEsQ0FBQSJ9

dist/smartcli.classes.smartcli.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="q" />
+import * as q from 'q';
+import { Subject } from 'rxjs';
+import { Objectmap } from 'lik';
+export interface ICommandPromiseObject {
+    commandName: string;
+    promise: q.Promise<void>;
+}
+export interface ITriggerObservableObject {
+    triggerName: string;
+    subject: Subject<void>;
+}
+export declare class Smartcli {
+    argv: any;
+    questionsDone: any;
+    parseStarted: any;
+    commands: any;
+    questions: any;
+    version: string;
+    /**
+     * 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 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): q.Promise<any>;
+    /**
+     * gets a Promise for a command word
+     */
+    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
+     */
+    addHelp(optionsArg: {
+        helpText: string;
+    }): void;
+    /**
+     * specify version to be printed for -v --version
+     */
+    addVersion(versionArg: string): void;
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
+    standardTask(): q.Promise<any>;
+    /**
+     * start the process of evaluating commands
+     */
+    startParse(): void;
+}

dist/smartcli.classes.smartcli.js

@@ -0,0 +1,133 @@
+"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() {
+        /**
+         * 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 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 done = q.defer();
+        this.allCommandPromisesMap.add({
+            commandName: commandNameArg,
+            promise: done.promise
+        });
+        this.parseStarted.promise
+            .then(() => {
+            if (this.argv._.indexOf(commandNameArg) === 0) {
+                done.resolve(this.argv);
+            }
+            else {
+                done.reject(this.argv);
+            }
+        });
+        return done.promise;
+    }
+    /**
+     * gets a Promise for a command word
+     */
+    getCommandPromiseByName(commandNameArg) {
+        return this.allCommandPromisesMap.find(commandDeferredObjectArg => {
+            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('help').then(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);
+            }
+        });
+    }
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
+    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) {
+                done.resolve(this.argv);
+            }
+            else {
+                done.reject(this.argv);
+            }
+        });
+        return done.promise;
+    }
+    /**
+     * start the process of evaluating commands
+     */
+    startParse() {
+        this.argv = this.argv.argv;
+        this.parseStarted.resolve();
+        return;
+    }
+}
+exports.Smartcli = Smartcli;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHVCQUFzQjtBQUN0QiwrQkFBOEI7QUFFOUIsOENBQTZDO0FBRTdDLGlCQUFpQjtBQUNqQiw2QkFBK0I7QUFhL0I7SUFrQkk7UUFWQTs7V0FFRztRQUNILDBCQUFxQixHQUFHLElBQUksZUFBUyxFQUF5QixDQUFBO1FBRTlEOztXQUVHO1FBQ0gsNkJBQXdCLEdBQUcsSUFBSSxlQUFTLEVBQTRCLENBQUE7UUFHaEUsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFBO1FBQ3pCLElBQUksQ0FBQyxhQUFhLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzlCLElBQUksQ0FBQyxZQUFZLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO0lBQ2pDLENBQUM7SUFFRDs7T0FFRztJQUNILGVBQWUsQ0FBQyxNQUFNLEVBQUMsUUFBUTtRQUMzQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBQyxRQUFRLENBQUMsQ0FBQTtRQUM1QyxNQUFNLENBQUE7SUFDVixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsVUFBVSxDQUFDLGNBQXNCO1FBQzdCLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQU8sQ0FBQTtRQUN6QixJQUFJLENBQUMscUJBQXFCLENBQUMsR0FBRyxDQUFDO1lBQzNCLFdBQVcsRUFBRSxjQUFjO1lBQzNCLE9BQU8sRUFBRSxJQUFJLENBQUMsT0FBTztTQUN4QixDQUFDLENBQUE7UUFDRixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQzNCLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDSixJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtZQUMxQixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7UUFDTixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCx1QkFBdUIsQ0FBQyxjQUFzQjtRQUMxQyxNQUFNLENBQUMsSUFBSSxDQUFDLHFCQUFxQixDQUFDLElBQUksQ0FBQyx3QkFBd0I7WUFDM0QsTUFBTSxDQUFDLHdCQUF3QixDQUFDLFdBQVcsS0FBSyxjQUFjLENBQUE7UUFDbEUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFBO0lBQ2QsQ0FBQztJQUVEOztPQUVHO0lBQ0gsVUFBVSxDQUFDLGNBQXNCO1FBQzdCLElBQUksY0FBYyxHQUFHLElBQUksY0FBTyxFQUFRLENBQUE7UUFDeEMsSUFBSSxDQUFDLHdCQUF3QixDQUFDLEdBQUcsQ0FBQztZQUM5QixXQUFXLEVBQUUsY0FBYztZQUMzQixPQUFPLEVBQUUsY0FBYztTQUMxQixDQUFDLENBQUE7UUFDRixJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDLElBQUksQ0FBQztZQUNqQyxjQUFjLENBQUMsSUFBSSxFQUFFLENBQUE7UUFDekIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsY0FBYyxDQUFBO0lBQ3pCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxPQUFPLENBQUMsV0FBbUI7UUFDdkIsSUFBSSxjQUFjLEdBQUcsSUFBSSxDQUFDLHdCQUF3QixDQUFDLElBQUksQ0FBQywwQkFBMEI7WUFDOUUsTUFBTSxDQUFDLDBCQUEwQixDQUFDLFdBQVcsS0FBSyxXQUFXLENBQUE7UUFDakUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFBO1FBQ1YsY0FBYyxDQUFDLElBQUksRUFBRSxDQUFBO1FBQ3JCLE1BQU0sQ0FBQyxjQUFjLENBQUE7SUFDekIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsT0FBTyxDQUFDLFVBRVA7UUFDRyxJQUFJLENBQUMsVUFBVSxDQUFDLE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPO1lBQ2hDLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUM5QyxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxVQUFrQjtRQUN6QixJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQTtRQUN6QixJQUFJLENBQUMsZUFBZSxDQUFDLEdBQUcsRUFBQyxTQUFTLENBQUMsQ0FBQTtRQUNuQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNkLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFBO1lBQzdCLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtJQUNWLENBQUM7SUFFRDs7T0FFRztJQUNILFlBQVk7UUFDUixJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsS0FBSyxFQUFPLENBQUE7UUFDekIsSUFBSSxDQUFDLHFCQUFxQixDQUFDLEdBQUcsQ0FBQztZQUMzQixXQUFXLEVBQUUsVUFBVTtZQUN2QixPQUFPLEVBQUUsSUFBSSxDQUFDLE9BQU87U0FDeEIsQ0FBQyxDQUFBO1FBQ0YsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPO2FBQ3BCLElBQUksQ0FBQztZQUNGLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLE1BQU0sS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzNDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQzNCLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDSixJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQTtZQUMxQixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUE7UUFDTixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ04sSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQTtRQUMxQixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQzNCLE1BQU0sQ0FBQTtJQUNWLENBQUM7Q0FFSjtBQS9JRCw0QkErSUMifQ==

dist/smartcli.plugins.d.ts

@@ -0,0 +1,7 @@
+import 'typings-global';
+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

@@ -0,0 +1,13 @@
+"use strict";
+require("typings-global");
+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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUV2QiwrQkFBOEI7QUFPMUIsc0JBQUs7QUFOVCx1Q0FBc0M7QUFPbEMsOEJBQVM7QUFOYiwyQkFBMEI7QUFPdEIsa0JBQUc7QUFOUCw2QkFBNEI7QUFPeEIsb0JBQUk7QUFOUix5Q0FBd0M7QUFPcEMsZ0NBQVUifQ==

docs/book.json

@@ -0,0 +1,15 @@
+{
+    "structure": {
+        "readme": "index.md"
+    },
+    "plugins": [
+        "tonic",
+        "edit-link"
+    ],
+    "pluginsConfig": {
+        "edit-link": {
+            "base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
+            "label": "Edit on GitLab"
+        }
+    }
+}

docs/index.md

@@ -0,0 +1,47 @@
+# smartcli
+nodejs wrapper for CLI related tasks. TypeScript ready.
+
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartcli)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartcli)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartcli)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartcli/docs)
+
+## 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)
+[![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/)
+
+## Install the package
+    npm install smartcli --save
+
+## Usage
+
+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' obviously is the tool (like git)
+* function 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)
+
+```typescript
+import {Smartcli} from "smartcli"
+mySmartcli = new Smartcli();
+mySmartcli.standardTask()
+  .then(argvArg => {
+    // do something if program is called without an command
+  });
+
+mySmartcli.question
+```

index.js

@@ -1,101 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var path = require("path");
-var beautylog = require("beautylog");
-var cliff = require("cliff");
-var inquirer = require("inquirer");
-var argv = require('yargs').argv;
-//define the smartcli object
-var smartcli = {};
-//add plugins from above for direct use
-smartcli.inquirer = inquirer;
-smartcli.cliff = cliff;
-smartcli.argv = argv;
-/* ------------------------------------------------------------------------------
- *----------------------- initial call CLI args -----------------------------
- *----------------------------------------------------------------------------- */
-// commands
-smartcli.checkCommand = function (commandString) {
-    if (argv._.indexOf(commandString) != -1) {
-        return true;
-    }
-    return false;
-};
-smartcli.getCommands = function () {
-    return argv._;
-};
-// options
-smartcli.checkOption = function (optionParam) {
-    if (argv.hasOwnProperty(optionParam)) {
-        return true;
-    }
-    return false;
-};
-smartcli.getOptions = function () {
-    var options = {};
-    for (var key in argv) {
-        if (key != "_") {
-            options['key'] = argv['key'];
-        }
-    }
-    return options;
-};
-/**
- * returns the current working directory
- * @returns {string}
- */
-smartcli.getCwd = function () {
-    return process.cwd();
-};
-/* ------------------------------------------------------------------------------
-*----------------------- in program CLI interaction -----------------------------
-*----------------------------------------------------------------------------- */
-/**
- * executes callback with answer to question as argument
- * @param questionString the question you want to ask the user
- * @param cb the function to execute with answer as param
- * @returns {null}
- */
-smartcli.getAnswer = function (questionString, cb) {
-    if (typeof questionString != 'string') {
-        beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function (value) {
-            return true;
-        }
-    };
-    inquirer.prompt([question], function (answers) {
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-smartcli.getChoice = function (questionString, choiceOptions, cb) {
-    if (!Array.isArray(choiceOptions)) {
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function (val) { return val.toLowerCase(); }
-    };
-    inquirer.prompt(question, function (answers) {
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-module.exports = smartcli;

npmts.json

@@ -0,0 +1,3 @@
+{
+    "mode":"default"
+}

package.json

@@ -1,37 +1,48 @@
 {
   "name": "smartcli",
-  "version": "0.0.7",
+  "version": "2.0.0",
   "description": "nodejs wrapper for CLI related tasks",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(cd ts/compile && gulp)",
+    "test": "(npmts)",
+    "testm": "(cd ts/compile && gulp) && (node test.js jazz jam --awesome)",
+    "devTest": "(npm test) && (node test.js --test true)",
     "reinstall": "(rm -r node_modules && npm install)",
     "release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
     "startdev": "(git checkout master && git pull origin master)"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pushrocks/smartcli.git"
+    "url": "https://gitlab.com/pushrocks/smartcli.git"
   },
   "keywords": [
-    "json",
-    "jade",
-    "template"
+    "cli",
+    "promise",
+    "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://github.com/pushrocks/smartcli/issues"
+    "url": "https://gitlab.com/pushrocks/smartcli/issues"
   },
-  "homepage": "https://github.com/pushrocks/smartcli",
+  "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "beautylog": "0.0.12",
-    "cliff": "^0.1.10",
-    "inquirer": "^0.10.1",
-    "yargs": "^3.26.0"
+    "@types/q": "0.x.x",
+    "@types/yargs": "6.x.x",
+    "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"
   },
   "devDependencies": {
-    "gulp": "3.9.0",
-    "gulp-typescript": "2.9.2"
+    "@types/should": "^8.1.30",
+    "npmts-g": "^5.2.8",
+    "should": "^11.1.1",
+    "typings-test": "^1.0.3"
   }
 }

test.js

@@ -1,33 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartcli = require("./index.js");
-var bl = require("beautylog");
-bl.log('now starting Test');
-bl.log('starting with initial CLI commands and options');
-var commandsString = 'You specified the following commands:';
-var commands = smartcli.getCommands();
-for (var key in commands) {
-    commandsString = commandsString + ' ' + commands[key];
-}
-bl.log(commandsString);
-if (smartcli.checkCommand('jazz')) {
-    bl.log('One of your commands is jazz');
-}
-else {
-    bl.log('None of your commands is jazz');
-}
-var getAnswerTest = function () {
-    smartcli.getAnswer('How do you feel?', function (answer) {
-        console.log('The answer is: ' + answer);
-        getChoiceTest();
-    });
-};
-var getChoiceTest = function () {
-    smartcli.getChoice('What music do you like to hear?', ['Jazz', 'Blues', 'Classical'], function (answer) {
-        console.log('The answer is: ' + answer);
-        getCwdTest();
-    });
-};
-var getCwdTest = function () {
-    console.log('The current directory is: ' + smartcli.getCwd());
-};
-getAnswerTest();

test/test.d.ts

@@ -0,0 +1 @@
+import 'typings-test';

test/test.js

@@ -0,0 +1,51 @@
+"use strict";
+require("typings-test");
+const smartcli = require("../dist/index");
+const should = require("should");
+describe('smartcli.Smartcli class', function () {
+    let smartCliTestObject;
+    describe('new Smartcli()', function () {
+        it('should create a new Smartcli', function () {
+            smartCliTestObject = new smartcli.Smartcli();
+            should(smartCliTestObject).be.instanceof(smartcli.Smartcli);
+        });
+    });
+    describe('.addCommand', function () {
+        it('should add an command', function () {
+            smartCliTestObject.addCommand('awesome');
+        });
+    });
+    describe('.standardTask', function () {
+        it('should start parsing a standardTask', function (done) {
+            smartCliTestObject.standardTask()
+                .then(() => {
+                console.log('this is the standard Task!');
+            });
+            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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQiwwQ0FBMEM7QUFDMUMsaUNBQWdDO0FBRWhDLFFBQVEsQ0FBQyx5QkFBeUIsRUFBQztJQUMvQixJQUFJLGtCQUFxQyxDQUFBO0lBQ3pDLFFBQVEsQ0FBQyxnQkFBZ0IsRUFBQztRQUN0QixFQUFFLENBQUMsOEJBQThCLEVBQUM7WUFDOUIsa0JBQWtCLEdBQUcsSUFBSSxRQUFRLENBQUMsUUFBUSxFQUFFLENBQUE7WUFDNUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDL0QsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxhQUFhLEVBQUM7UUFDbkIsRUFBRSxDQUFDLHVCQUF1QixFQUFDO1lBQ3ZCLGtCQUFrQixDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQTtRQUM1QyxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0lBQ0YsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixFQUFFLENBQUMscUNBQXFDLEVBQUMsVUFBUyxJQUFJO1lBQ2xELGtCQUFrQixDQUFDLFlBQVksRUFBRTtpQkFDNUIsSUFBSSxDQUFDO2dCQUNGLE9BQU8sQ0FBQyxHQUFHLENBQUMsNEJBQTRCLENBQUMsQ0FBQTtZQUM3QyxDQUFDLENBQUMsQ0FBQTtZQUNOLElBQUksRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxVQUFVLEVBQUU7UUFDakIsSUFBSSxXQUFXLEdBQUcsS0FBSyxDQUFBO1FBQ3ZCLEVBQUUsQ0FBQyx5QkFBeUIsRUFBRSxVQUFTLElBQUk7WUFDdkMsa0JBQWtCLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQztpQkFDckMsU0FBUyxDQUFDO2dCQUNQLFdBQVcsR0FBRyxJQUFJLENBQUE7WUFDdEIsQ0FBQyxDQUFDLENBQUE7WUFDTixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsRUFBRSxDQUFDLDhCQUE4QixFQUFFO1lBQy9CLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDbEMsQ0FBQyxDQUFDLENBQUE7UUFDRixFQUFFLENBQUMsK0JBQStCLEVBQUUsVUFBUyxJQUFJO1lBQzdDLGtCQUFrQixDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUN2QyxNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFBO1lBQzdCLElBQUksRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxhQUFhLEVBQUM7UUFDbkIsRUFBRSxDQUFDLG9DQUFvQyxFQUFDO1lBQ3BDLGtCQUFrQixDQUFDLFVBQVUsRUFBRSxDQUFBO1FBQ25DLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQSJ9

test/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC3C,IAAI,MAAM,GAAG,GAAG,CAAA;AAEhB;;wEAEwE;AAExE,QAAQ,CAAC,UAAU,EAAC;IAChB,QAAQ,CAAC,QAAQ,EAAC;QACd,QAAQ,CAAC,UAAU,EAAC;YAChB,EAAE,CAAC,oDAAoD,EAAC;gBACpD,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YACpD,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,yDAAyD,EAAC;gBACzD,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YACrD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,kBAAkB,EAAC;QAE5B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAKH,IAAI,wBAAwB,GAAG;IAC3B,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,SAAS,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAC/D,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,SAAS,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,SAAS,CAAC,OAAO,CAAC,mEAAmE,CAAC,CAAC;IAC3F,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,gFAAgF,CAAC,CAAC;QAClG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AACF,wBAAwB,EAAE,CAAC;AAE3B,IAAI,gCAAgC,GAAG;IACnC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,SAAS,CAAC,OAAO,CAAC,uCAAuC,CAAC,CAAC;IAC/D,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,SAAS,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC;IAChE,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;QACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AACF,gCAAgC,EAAE,CAAC;AAEnC;;wEAEwE;AACxE,IAAI,cAAc,GAAG;IACjB,IAAI,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACxC,EAAE,CAAA,CAAC,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;QAC3B,SAAS,CAAC,OAAO,CAAC,gDAAgD,CAAC,CAAC;IACxE,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACjF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AAEL,CAAC,CAAC;AACF,cAAc,EAAE,CAAC;AAEjB,IAAI,sBAAsB,GAAG;IACzB,IAAI,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAClD,IAAI,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACnD,EAAE,CAAA,CAAC,WAAW,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC;QAC3B,SAAS,CAAC,OAAO,CAAC,8DAA8D,CAAC,CAAC;IACtF,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAC;QAC/F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,EAAE,CAAA,CAAC,YAAY,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;QAClC,SAAS,CAAC,OAAO,CAAC,qEAAqE,CAAC,CAAC;IAC7F,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACtG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AACF,sBAAsB,EAAE,CAAC;AAEzB,IAAI,kBAAkB,GAAG;IACrB,IAAI,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;IAC7C,EAAE,CAAA,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC;QAC9B,SAAS,CAAC,OAAO,CAAC,2CAA2C,CAAC,CAAC;IACnE,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC5E,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AACF,kBAAkB,EAAE,CAAC;AAErB,IAAI,aAAa,GAAG;IAChB,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/C,IAAI,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACjD,EAAE,CAAA,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA,CAAC;QACpB,SAAS,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAA;IACvD,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAC;QACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,EAAE,CAAA,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA,CAAC;QACtB,SAAS,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAA;IAC5D,CAAC;IAAC,IAAI,CAAC,CAAC;QACJ,SAAS,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC9D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;AACL,CAAC,CAAC;AACF,aAAa,EAAE,CAAC;AAEhB,IAAI,UAAU,GAAG;IACb,SAAS,CAAC,IAAI,CAAC,4BAA4B,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AAC3E,CAAC,CAAC;AACF,UAAU,EAAE,CAAC;AAGb;;wEAEwE;AAGxE,IAAI,wBAAwB,GAAG;IAC3B,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,kBAAkB,EAAC,UAAS,MAAM;QAC7D,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,MAAM,CAAC,CAAC;QACxC,wBAAwB,EAAE,CAAC;IAC/B,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAIF,IAAI,wBAAwB,GAAG;IAC3B,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,iCAAiC,EAAC,CAAC,MAAM,EAAC,OAAO,EAAC,WAAW,CAAC,EAAC,UAAS,MAAM;QACzG,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,MAAM,CAAC,CAAC;QACxC,QAAQ,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,IAAI,QAAQ,GAAG;IACX,SAAS,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC;IAC/B,SAAS,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,EAAE,CAAA,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA,CAAC;IACjC,wBAAwB,EAAE,CAAC;AAC/B,CAAC;AAAC,IAAI,CAAC,CAAC;IACJ,SAAS,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;IAC3F,QAAQ,EAAE,CAAC;AACf,CAAC;AAAA,CAAC"}

test/test.ts

@@ -0,0 +1,51 @@
+import 'typings-test'
+
+import smartcli = require('../dist/index')
+import * as should from 'should'
+
+describe('smartcli.Smartcli class',function(){
+    let smartCliTestObject: smartcli.Smartcli
+    describe('new Smartcli()',function(){
+        it('should create a new Smartcli',function(){
+            smartCliTestObject = new smartcli.Smartcli()
+            should(smartCliTestObject).be.instanceof(smartcli.Smartcli)
+        })
+    })
+    describe('.addCommand',function(){
+        it('should add an command',function(){
+            smartCliTestObject.addCommand('awesome')
+        })
+    })
+    describe('.standardTask',function(){
+        it('should start parsing a standardTask',function(done){
+            smartCliTestObject.standardTask()
+                .then(() => {
+                    console.log('this is the standard Task!')
+                })
+            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/compile/gulpfile.js

@@ -1,25 +0,0 @@
-// import gulp
-var gulp = require("gulp"),
-	gulpTypescript = require("gulp-typescript");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('compileTestTS', function() {
-	var stream = gulp.src('../test.ts')
-			.pipe(gulpTypescript({
-				out: "test.js"
-			}))
-			.pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS','compileTestTS'], function() {
-	console.log('Typescript compiled');
-});

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.ts

@@ -1,133 +1 @@
-/// <reference path="typings/tsd.d.ts" />
-
-var path = require("path");
-var beautylog = require("beautylog");
-var cliff = require("cliff");
-var inquirer = require("inquirer");
-var argv = require('yargs').argv;
-
-//define the smartcli object
-var smartcli:any = {};
-
-//add plugins from above for direct use
-smartcli.inquirer = inquirer;
-smartcli.cliff = cliff;
-smartcli.argv = argv;
-
-/* ------------------------------------------------------------------------------
- *----------------------- initial call CLI args -----------------------------
- *----------------------------------------------------------------------------- */
-
-// commands
-
-
-smartcli.checkCommand = function(commandString:string):boolean {
-    if (argv._.indexOf(commandString) != -1) {
-        return true
-    }
-    return false;
-};
-
-smartcli.getCommands = function ():string[] {
-    return argv._;
-};
-
-
-// options
-smartcli.checkOption = function(optionParam:string):boolean {
-    if (argv.hasOwnProperty(optionParam)) {
-        return true;
-    }
-    return false
-};
-
-smartcli.getOptionValue = function(optionParam:string):any {
-    if (smartcli.checkOption(optionParam)) {
-        return argv[optionParam]
-    }
-    return false;
-};
-
-smartcli.getOptions = function() {
-    var options = {};
-    for (var key in argv) {
-        if (key != "_") {
-            options['key'] = argv['key'];
-        }
-    }
-    return options;
-};
-
-/**
- * returns the current working directory
- * @returns {string}
- */
-smartcli.getCwd = function () {
-    return process.cwd();
-};
-
-
-
-/* ------------------------------------------------------------------------------
-*----------------------- in program CLI interaction -----------------------------
-*----------------------------------------------------------------------------- */
-
-
-
-/**
- * executes callback with answer to question as argument
- * @param questionString the question you want to ask the user
- * @param cb the function to execute with answer as param
- * @returns {null}
- */
-smartcli.getAnswer = function(questionString:string, cb) {
-    if (typeof questionString != 'string') {
-        beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    var question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function( value ) {
-            return true;
-        }
-    };
-
-    inquirer.prompt([question],function(answers){
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-smartcli.getChoice = function(questionString:string, choiceOptions:string[], cb) {
-    if(!Array.isArray(choiceOptions)) {
-        return null;
-    }
-
-    //make inquirer compatible question object
-    var question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function( val ) { return val.toLowerCase(); }
-    };
-
-    inquirer.prompt(question,function(answers){
-        var answer = answers.userFeedback;
-        cb(answer);
-    });
-
-};
-
-
-module.exports = smartcli;
+export { Smartcli } from './smartcli.classes.smartcli'

ts/smartcli.classes.smartcli.ts

@@ -0,0 +1,163 @@
+import * as q from 'q'
+import { Subject } from 'rxjs'
+
+import * as plugins from './smartcli.plugins'
+
+// import classes
+import { Objectmap } from 'lik'
+
+// interfaces
+export interface ICommandPromiseObject {
+    commandName: string,
+    promise: q.Promise<void>
+}
+
+export interface ITriggerObservableObject {
+    triggerName: string
+    subject: Subject<void>
+}
+
+export class Smartcli {
+    argv: any
+    questionsDone
+    parseStarted
+    commands
+    questions
+    version: string
+
+    /**
+     * 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()
+        this.parseStarted = q.defer()
+    }
+
+    /**
+     * 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
+    }
+
+    /**
+     * 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): q.Promise<any> {
+        let done = q.defer<any>()
+        this.allCommandPromisesMap.add({
+            commandName: commandNameArg,
+            promise: done.promise
+        })
+        this.parseStarted.promise
+            .then(() => {
+                if (this.argv._.indexOf(commandNameArg) === 0) {
+                    done.resolve(this.argv)
+                } else {
+                    done.reject(this.argv)
+                }
+            })
+        return done.promise
+    }
+
+    /**
+     * gets a Promise for a command word
+     */
+    getCommandPromiseByName(commandNameArg: string): q.Promise<void> {
+        return this.allCommandPromisesMap.find(commandDeferredObjectArg => {
+            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('help').then(argvArg => {
+            plugins.beautylog.log(optionsArg.helpText)
+        })
+    }
+
+    /**
+     * specify version to be printed for -v --version
+     */
+    addVersion(versionArg: string) {
+        this.version = versionArg
+        this.addCommandAlias('v','version')
+        this.parseStarted.promise
+            .then(() => {
+                if (this.argv.v) {
+                    console.log(this.version)
+                }
+            })
+    }
+
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
+    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) {
+                    done.resolve(this.argv)
+                } else {
+                    done.reject(this.argv)
+                }
+            })
+        return done.promise
+    }
+
+    /**
+     * start the process of evaluating commands
+     */
+    startParse(): void {
+        this.argv = this.argv.argv
+        this.parseStarted.resolve()
+        return
+    }
+
+}

ts/smartcli.plugins.ts

@@ -0,0 +1,15 @@
+import 'typings-global'
+
+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
+}

ts/test.ts

@@ -1,40 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var smartcli = require("./index.js");
-var bl = require("beautylog");
-
-bl.log('now starting Test');
-bl.log('starting with initial CLI commands and options');
-
-var commandsString:string = 'You specified the following commands:';
-var commands = smartcli.getCommands();
-for (var key in commands) {
-    commandsString = commandsString + ' ' + commands[key];
-}
-bl.log(commandsString);
-
-if (smartcli.checkCommand('jazz')) {
-    bl.log('One of your commands is jazz');
-} else {
-    bl.log('None of your commands is jazz');
-}
-
-
-var getAnswerTest = function() {
-    smartcli.getAnswer('How do you feel?',function(answer){
-        console.log('The answer is: ' + answer);
-        getChoiceTest();
-    });
-};
-
-var getChoiceTest = function() {
-    smartcli.getChoice('What music do you like to hear?',['Jazz','Blues','Classical'],function(answer){
-        console.log('The answer is: ' + answer);
-        getCwdTest();
-    });
-};
-
-var getCwdTest = function(){
-    console.log('The current directory is: ' + smartcli.getCwd());
-};
-
-getAnswerTest();

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />

tslint.json

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