1.0.6

.gitignore

@@ -1,8 +1,6 @@
 node_modules/
-.settings/
-.idea/
 coverage/
-docs/
+pages/
 
 
 ts/*.js

.gitlab-ci.yml

@@ -3,6 +3,7 @@ image: hosttoday/ht-docker-node:npmci
 stages:
 - test
 - release
+- page
 
 testLEGACY:
   stage: test
@@ -34,4 +35,16 @@ release:
     - tags
   tags:
     - docker
-    
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: page
+  script:
+    - npmci command npmts
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

README.md

@@ -1,11 +1,20 @@
 # smartcli
 nodejs wrapper for CLI related tasks. TypeScript ready.
 
-## Status
+## Availabililty
-[![Build Status](https://travis-ci.org/pushrocks/smartcli.svg?branch=master)](https://travis-ci.org/pushrocks/smartcli)
+[![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 Overall Score](https://www.bithound.io/github/pushrocks/smartcli/badges/score.svg)](https://www.bithound.io/github/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
@@ -17,38 +26,22 @@ this plugin tries to establish some logic in which CLI tools work.
 take the following commandline input:
 
 ```
-mytool function argument1 argument2 --option1 option1Value --option2 option2Value
+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)
-* option is an option you can add (like -m for message)
+* 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)
 
-
-### The inner organization of smartcli
-**smartcli** exposes three major groups of functions:
-
-* check functions
-  * are grouped in **smartcli.checks** object
-* get functions
-  * are grouped in **smartcli.get** object
-* async interaction functions
-  * are grouped in **smartcli.interaction** object
-
-
-### Methods
-The examples are written in TypeScript
 ```typescript
-import * as smartcli from  "smartcli"
+import {Smartcli} from "smartcli"
-
+mySmartcli = new Smartcli();
-/* -------------- Check Functions -------------------*/
+mySmartcli.standardTask()
-smartcli.check.command("jazz"); // check  for a special command.
+  .then(argvArg => {
-smartcli.check.commandPresence() // check if any command is specified
+    // do something if program is called without an command
-smartcli.check.commandArguemnt("myargument",1) // checks if a special argument is given, second argument is level
+  });
-smartcli.check.commandArguemntPresence // checks of any Argument is present
-smartcli.check.option("someoption") // checks for a specific option
-smartcli.check.optionPresence() // checks if any option is specified
-smartcli.get.option('myoption'); // 
-```
 
+mySmartcli.question
+```

dist/smartcli.classes.interaction.d.ts

@@ -1,4 +1,32 @@
 import "typings-global";
-export declare class Question {
+/**
+ * allows to specify an user interaction during runtime
+ */
+export declare type questionType = "input" | "confirm" | "list" | "rawlist" | "expand" | "checkbox" | "password" | "editor";
+export interface choiceObject {
+    name: string;
+    value: any;
+}
+export interface validateFunction {
+    (any: any): boolean;
+}
+export declare class Interaction {
+    constructor();
+    askQuestion(optionsArg: {
+        type: questionType;
+        message: string;
+        default: any;
+        choices: string[] | choiceObject[];
+        validate: validateFunction;
+    }): void;
+    askQuestionArray: any;
+}
+export declare class QuestionTree {
+    constructor(questionString: string, optionsArray: any);
+}
+export declare class QuestionTreeNode {
+    constructor();
+}
+export declare class QuestionStorage {
     constructor();
 }

dist/smartcli.classes.interaction.helpers.d.ts

@@ -1,17 +0,0 @@
-import "typings-global";
-import "./smartcli.interfaces";
-/**
- * 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}
- */
-export declare let getAnswer: (questionString: string, cb: any) => any;
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-export declare let getChoice: (questionString: string, choiceOptions: string[], cb: any) => any;

dist/smartcli.classes.interaction.helpers.js

@@ -1,54 +0,0 @@
-"use strict";
-require("typings-global");
-require("./smartcli.interfaces");
-const plugins = require("./smartcli.plugins");
-/**
- * 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}
- */
-exports.getAnswer = function (questionString, cb) {
-    if (typeof questionString != 'string') {
-        plugins.beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    let question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function (value) {
-            return true;
-        }
-    };
-    plugins.inquirer.prompt([question], function (answers) {
-        let answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-exports.getChoice = function (questionString, choiceOptions, cb) {
-    if (!Array.isArray(choiceOptions)) {
-        return null;
-    }
-    //make inquirer compatible question object
-    let question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function (val) { return val.toLowerCase(); }
-    };
-    plugins.inquirer.prompt(question, function (answers) {
-        let answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5pbnRlcmFjdGlvbi5oZWxwZXJzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRjbGkuY2xhc3Nlcy5pbnRlcmFjdGlvbi5oZWxwZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFFeEIsUUFBTyx1QkFBdUIsQ0FBQyxDQUFBO0FBQy9CLE1BQU8sT0FBTyxXQUFXLG9CQUFvQixDQUFDLENBQUM7QUFFL0M7Ozs7O0dBS0c7QUFDUSxpQkFBUyxHQUFHLFVBQVMsY0FBcUIsRUFBRSxFQUFFO0lBQ3JELEVBQUUsQ0FBQyxDQUFDLE9BQU8sY0FBYyxJQUFJLFFBQVEsQ0FBQyxDQUFDLENBQUM7UUFDcEMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsdUJBQXVCLENBQUMsQ0FBQztRQUNqRCxNQUFNLENBQUMsSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFDRCwwQ0FBMEM7SUFDMUMsSUFBSSxRQUFRLEdBQUc7UUFDWCxJQUFJLEVBQUUsT0FBTztRQUNiLElBQUksRUFBRSxjQUFjO1FBQ3BCLE9BQU8sRUFBRSxjQUFjO1FBQ3ZCLFFBQVEsRUFBRSxVQUFVLEtBQUs7WUFDckIsTUFBTSxDQUFDLElBQUksQ0FBQztRQUNoQixDQUFDO0tBQ0osQ0FBQztJQUVGLE9BQU8sQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUMsUUFBUSxDQUFDLEVBQUMsVUFBUyxPQUFPO1FBQy9DLElBQUksTUFBTSxHQUFHLE9BQU8sQ0FBQyxZQUFZLENBQUM7UUFDbEMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2YsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUM7QUFFRjs7Ozs7O0dBTUc7QUFDUSxpQkFBUyxHQUFHLFVBQVMsY0FBcUIsRUFBRSxhQUFzQixFQUFFLEVBQUU7SUFDN0UsRUFBRSxDQUFBLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUMvQixNQUFNLENBQUMsSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFFRCwwQ0FBMEM7SUFDMUMsSUFBSSxRQUFRLEdBQUc7UUFDWCxJQUFJLEVBQUUsTUFBTTtRQUNaLElBQUksRUFBRSxjQUFjO1FBQ3BCLE9BQU8sRUFBRSxjQUFjO1FBQ3ZCLE9BQU8sRUFBRSxhQUFhO1FBQ3RCLE1BQU0sRUFBRSxVQUFVLEdBQUcsSUFBSyxNQUFNLENBQUMsR0FBRyxDQUFDLFdBQVcsRUFBRSxDQUFDLENBQUMsQ0FBQztLQUN4RCxDQUFDO0lBRUYsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFDLFVBQVMsT0FBTztRQUM3QyxJQUFJLE1BQU0sR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDO1FBQ2xDLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNmLENBQUMsQ0FBQyxDQUFDO0FBRVAsQ0FBQyxDQUFDIn0=

dist/smartcli.classes.interaction.js

@@ -1,8 +1,41 @@
 "use strict";
 require("typings-global");
-class Question {
+const plugins = require("./smartcli.plugins");
+class Interaction {
+    constructor() {
+    }
+    ;
+    askQuestion(optionsArg) {
+        let done = plugins.q.defer();
+        plugins.inquirer.prompt([{
+                type: optionsArg.type,
+                message: optionsArg.message,
+                default: optionsArg.default,
+                choices: optionsArg.choices,
+                validate: optionsArg.validate
+            }]).then(answers => {
+            done.resolve(answers);
+        });
+    }
+    ;
+}
+exports.Interaction = Interaction;
+class QuestionTree {
+    constructor(questionString, optionsArray) {
+    }
+    ;
+}
+exports.QuestionTree = QuestionTree;
+;
+class QuestionTreeNode {
     constructor() {
     }
 }
-exports.Question = Question;
+exports.QuestionTreeNode = QuestionTreeNode;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5pbnRlcmFjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuaW50ZXJhY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUd4QjtJQUNJO0lBRUEsQ0FBQztBQUNMLENBQUM7QUFKWSxnQkFBUSxXQUlwQixDQUFBIn0=
+;
+class QuestionStorage {
+    constructor() {
+    }
+}
+exports.QuestionStorage = QuestionStorage;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5pbnRlcmFjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuaW50ZXJhY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxvQkFBb0IsQ0FBQyxDQUFBO0FBZTlDO0lBQ0k7SUFDQSxDQUFDOztJQUVELFdBQVcsQ0FBQyxVQU1YO1FBQ0csSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM3QixPQUFPLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDO2dCQUNyQixJQUFJLEVBQUUsVUFBVSxDQUFDLElBQUk7Z0JBQ3JCLE9BQU8sRUFBRSxVQUFVLENBQUMsT0FBTztnQkFDM0IsT0FBTyxFQUFFLFVBQVUsQ0FBQyxPQUFPO2dCQUMzQixPQUFPLEVBQUMsVUFBVSxDQUFDLE9BQU87Z0JBQzFCLFFBQVEsRUFBRSxVQUFVLENBQUMsUUFBUTthQUNoQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsT0FBTztZQUNaLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDMUIsQ0FBQyxDQUFDLENBQUM7SUFDUCxDQUFDOztBQUVMLENBQUM7QUF2QlksbUJBQVcsY0F1QnZCLENBQUE7QUFHRDtJQUVJLFlBQVksY0FBc0IsRUFBRSxZQUFZO0lBRWhELENBQUM7O0FBQ0wsQ0FBQztBQUxZLG9CQUFZLGVBS3hCLENBQUE7QUFBQSxDQUFDO0FBRUY7SUFDSTtJQUVBLENBQUM7QUFDTCxDQUFDO0FBSlksd0JBQWdCLG1CQUk1QixDQUFBO0FBQUEsQ0FBQztBQUVGO0lBQ0k7SUFFQSxDQUFDO0FBQ0wsQ0FBQztBQUpZLHVCQUFlLGtCQUkzQixDQUFBIn0=

dist/smartcli.classes.smartcli.d.ts

@@ -1,6 +1,11 @@
 /// <reference types="q" />
 import "typings-global";
 import * as plugins from "./smartcli.plugins";
+import { Objectmap } from "lik";
+export interface commandPromiseObject {
+    commandName: string;
+    promise: plugins.q.Promise<any>;
+}
 export declare class Smartcli {
     argv: any;
     questionsDone: any;
@@ -8,6 +13,7 @@ export declare class Smartcli {
     commands: any;
     questions: any;
     version: string;
+    allCommandPromises: Objectmap<commandPromiseObject>;
     constructor();
     /**
      * adds an alias, meaning one equals the other in terms of triggering associated commands
@@ -24,13 +30,23 @@ export declare class Smartcli {
     /**
      * gets a Promise for a command word
      */
-    getCommandPromise(commandNameArg: any): void;
+    getCommandPromiseByName(commandNameArg: string): plugins.q.Promise<any>;
-    addQuestion(definitionArg: {
+    /**
-        questionString: string;
+     * allows to specify help text to be printed above the rest of the help text
-        questionType: string;
+     */
+    addHelp(optionsArg: {
+        helpText: string;
     }): void;
-    addHelp(): void;
+    /**
+     * specify version to be printed for -v --version
+     */
     addVersion(versionArg: string): void;
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
     standardTask(): plugins.q.Promise<{}>;
+    /**
+     * start the process of evaluating commands
+     */
     startParse(): void;
 }

dist/smartcli.classes.smartcli.js

@@ -1,9 +1,14 @@
 "use strict";
 require("typings-global");
 const plugins = require("./smartcli.plugins");
+// import classes
+const lik_1 = require("lik");
+;
 class Smartcli {
     constructor() {
-        this.argv = plugins.argv;
+        // maps
+        this.allCommandPromises = new lik_1.Objectmap();
+        this.argv = plugins.yargs;
         this.questionsDone = plugins.q.defer();
         this.parseStarted = plugins.q.defer();
     }
@@ -37,14 +42,26 @@ class Smartcli {
     /**
      * gets a Promise for a command word
      */
-    getCommandPromise(commandNameArg) {
+    getCommandPromiseByName(commandNameArg) {
-        //TODO
+        return this.allCommandPromises.find(commandPromiseObjectArg => {
-    }
+            return commandPromiseObjectArg.commandName === commandNameArg;
-    addQuestion(definitionArg) {
+        }).promise;
     }
     ;
-    addHelp() {
+    /**
+     * allows to specify help text to be printed above the rest of the help text
+     */
+    addHelp(optionsArg) {
+        this.addCommand({
+            commandName: "help"
+        }).then(argvArg => {
+            plugins.beautylog.log(optionsArg.helpText);
+        });
     }
+    ;
+    /**
+     * specify version to be printed for -v --version
+     */
     addVersion(versionArg) {
         this.version = versionArg;
         this.addAlias("v", "version");
@@ -55,6 +72,10 @@ class Smartcli {
             }
         });
     }
+    ;
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
     standardTask() {
         let done = plugins.q.defer();
         this.parseStarted.promise
@@ -69,10 +90,13 @@ class Smartcli {
         });
         return done.promise;
     }
+    /**
+     * start the process of evaluating commands
+     */
     startParse() {
         this.argv = this.argv.argv;
         this.parseStarted.resolve();
     }
 }
 exports.Smartcli = Smartcli;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUV4QixNQUFZLE9BQU8sV0FBTSxvQkFBb0IsQ0FBQyxDQUFBO0FBRzlDO0lBT0k7UUFDSSxJQUFJLENBQUMsSUFBSSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUM7UUFDekIsSUFBSSxDQUFDLGFBQWEsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3ZDLElBQUksQ0FBQyxZQUFZLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUMxQyxDQUFDOztJQUVEOztPQUVHO0lBQ0gsUUFBUSxDQUFDLE1BQU0sRUFBQyxRQUFRO1FBQ3BCLElBQUksQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxFQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2pELENBQUM7O0lBRUQ7Ozs7T0FJRztJQUNILFVBQVUsQ0FBQyxhQUFrQztRQUN6QyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzdCLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTzthQUNwQixJQUFJLENBQUM7WUFDRixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsYUFBYSxDQUFDLFdBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQ3RELElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzVCLENBQUM7WUFBQyxJQUFJLENBQUMsQ0FBQztnQkFDSixJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUMzQixDQUFDO1FBQ0wsQ0FBQyxDQUFDLENBQUM7UUFDUCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDOztJQUVEOztPQUVHO0lBQ0gsaUJBQWlCLENBQUMsY0FBYztRQUM1QixNQUFNO0lBQ1YsQ0FBQztJQUNELFdBQVcsQ0FBQyxhQUF5RDtJQUVyRSxDQUFDOztJQUNELE9BQU87SUFFUCxDQUFDO0lBQ0QsVUFBVSxDQUFDLFVBQWlCO1FBQ3hCLElBQUksQ0FBQyxPQUFPLEdBQUcsVUFBVSxDQUFDO1FBQzFCLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxFQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQzdCLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTzthQUNwQixJQUFJLENBQUM7WUFDRixFQUFFLENBQUEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBLENBQUM7Z0JBQ1osT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDOUIsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO0lBQ1YsQ0FBQztJQUNELFlBQVk7UUFDUixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzdCLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTzthQUNwQixJQUFJLENBQUM7WUFDRixFQUFFLENBQUEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQSxDQUFDO2dCQUN4QyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUM1QixDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQztZQUFBLENBQUM7UUFDTixDQUFDLENBQUMsQ0FBQztRQUNQLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ3hCLENBQUM7SUFDRCxVQUFVO1FBQ04sSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztRQUMzQixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2hDLENBQUM7QUFFTCxDQUFDO0FBN0VZLGdCQUFRLFdBNkVwQixDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkuY2xhc3Nlcy5zbWFydGNsaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLmNsYXNzZXMuc21hcnRjbGkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUV4QixNQUFZLE9BQU8sV0FBTSxvQkFBb0IsQ0FBQyxDQUFBO0FBRzlDLGlCQUFpQjtBQUNqQixzQkFBd0IsS0FBSyxDQUFDLENBQUE7QUFNN0IsQ0FBQztBQUVGO0lBVUk7UUFGQSxPQUFPO1FBQ1AsdUJBQWtCLEdBQUcsSUFBSSxlQUFTLEVBQXdCLENBQUM7UUFFdkQsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDO1FBQzFCLElBQUksQ0FBQyxhQUFhLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUN2QyxJQUFJLENBQUMsWUFBWSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDMUMsQ0FBQzs7SUFFRDs7T0FFRztJQUNILFFBQVEsQ0FBQyxNQUFNLEVBQUMsUUFBUTtRQUNwQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sRUFBQyxRQUFRLENBQUMsQ0FBQztJQUNqRCxDQUFDOztJQUVEOzs7O09BSUc7SUFDSCxVQUFVLENBQUMsYUFBa0M7UUFDekMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM3QixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLGFBQWEsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUN0RCxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztZQUM1QixDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDM0IsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFDO1FBQ1AsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7SUFDeEIsQ0FBQzs7SUFFRDs7T0FFRztJQUNILHVCQUF1QixDQUFDLGNBQXFCO1FBQ3pDLE1BQU0sQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLHVCQUF1QjtZQUN2RCxNQUFNLENBQUMsdUJBQXVCLENBQUMsV0FBVyxLQUFLLGNBQWMsQ0FBQztRQUNsRSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUM7SUFDZixDQUFDOztJQUVEOztPQUVHO0lBQ0gsT0FBTyxDQUFDLFVBRVA7UUFDRyxJQUFJLENBQUMsVUFBVSxDQUFDO1lBQ1osV0FBVyxFQUFDLE1BQU07U0FDckIsQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPO1lBQ1gsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQy9DLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQzs7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxVQUFpQjtRQUN4QixJQUFJLENBQUMsT0FBTyxHQUFHLFVBQVUsQ0FBQztRQUMxQixJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsRUFBQyxTQUFTLENBQUMsQ0FBQztRQUM3QixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFBLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQSxDQUFDO2dCQUNaLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1lBQzlCLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtJQUNWLENBQUM7O0lBRUQ7O09BRUc7SUFDSCxZQUFZO1FBQ1IsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM3QixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU87YUFDcEIsSUFBSSxDQUFDO1lBQ0YsRUFBRSxDQUFBLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUEsQ0FBQztnQkFDeEMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDNUIsQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLElBQUksQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQzNCLENBQUM7WUFBQSxDQUFDO1FBQ04sQ0FBQyxDQUFDLENBQUM7UUFDUCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxVQUFVO1FBQ04sSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQztRQUMzQixJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2hDLENBQUM7QUFFTCxDQUFDO0FBckdZLGdCQUFRLFdBcUdwQixDQUFBIn0=

dist/smartcli.plugins.d.ts

@@ -1,9 +1,9 @@
 import "typings-global";
-export declare let argv: any;
+export import yargs = require('yargs');
 export import beautylog = require("beautylog");
-export declare let cliff: any;
+export import cliff = require("cliff");
-export declare let inquirer: any;
+export import inquirer = require("inquirer");
 export import lik = require("lik");
-export declare let path: any;
+export import path = require("path");
 export import q = require("q");
 export import smartparam = require("smartparam");

dist/smartcli.plugins.js

@@ -1,6 +1,6 @@
 "use strict";
 require("typings-global");
-exports.argv = require('yargs');
+exports.yargs = require('yargs');
 exports.beautylog = require("beautylog");
 exports.cliff = require("cliff");
 exports.inquirer = require("inquirer");
@@ -8,4 +8,4 @@ exports.lik = require("lik");
 exports.path = require("path");
 exports.q = require("q");
 exports.smartparam = require("smartparam");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUViLFlBQUksR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7QUFDckIsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNwQyxhQUFLLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBQ3pCLGdCQUFRLEdBQUcsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0FBQzVCLFdBQUcsV0FBVyxLQUFLLENBQUMsQ0FBQztBQUN4QixZQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQ3BCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixrQkFBVSxXQUFXLFlBQVksQ0FBQyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjbGkucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y2xpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUVWLGFBQUssV0FBVyxPQUFPLENBQUMsQ0FBQztBQUN6QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLGFBQUssV0FBVyxPQUFPLENBQUMsQ0FBQztBQUN6QixnQkFBUSxXQUFXLFVBQVUsQ0FBQyxDQUFDO0FBQy9CLFdBQUcsV0FBVyxLQUFLLENBQUMsQ0FBQztBQUNyQixZQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDdkIsU0FBQyxXQUFXLEdBQUcsQ0FBQyxDQUFDO0FBQ2pCLGtCQUFVLFdBQVcsWUFBWSxDQUFDLENBQUMifQ==

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
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartcli",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "nodejs wrapper for CLI related tasks",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,7 +28,10 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartcli",
   "dependencies": {
-    "@types/q": "0.0.30",
+    "@types/cliff": "^0.1.3",
+    "@types/inquirer": "0.x.x",
+    "@types/q": "0.x.x",
+    "@types/yargs": "0.x.x",
     "beautylog": "^5.0.20",
     "cliff": "^0.1.10",
     "inquirer": "^1.1.2",

ts/smartcli.classes.interaction.helpers.ts

@@ -1,59 +0,0 @@
-import "typings-global";
-
-import "./smartcli.interfaces";
-import plugins = require("./smartcli.plugins");
-
-/**
- * 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}
- */
-export let getAnswer = function(questionString:string, cb) {
-    if (typeof questionString != 'string') {
-        plugins.beautylog.error('no question specified');
-        return null;
-    }
-    //make inquirer compatible question object
-    let question = {
-        type: "input",
-        name: "userFeedback",
-        message: questionString,
-        validate: function( value ) {
-            return true;
-        }
-    };
-
-    plugins.inquirer.prompt([question],function(answers){
-        let answer = answers.userFeedback;
-        cb(answer);
-    });
-};
-
-/**
- *
- * @param questionString
- * @param choiceOptions
- * @param cb
- * @returns {null}
- */
-export let getChoice = function(questionString:string, choiceOptions:string[], cb) {
-    if(!Array.isArray(choiceOptions)) {
-        return null;
-    }
-
-    //make inquirer compatible question object
-    let question = {
-        type: "list",
-        name: "userFeedback",
-        message: questionString,
-        choices: choiceOptions,
-        filter: function( val ) { return val.toLowerCase(); }
-    };
-
-    plugins.inquirer.prompt(question,function(answers){
-        let answer = answers.userFeedback;
-        cb(answer);
-    });
-
-};

ts/smartcli.classes.interaction.ts

@@ -1,8 +1,60 @@
 import "typings-global";
 import * as plugins from "./smartcli.plugins";
 
-export class Question {
+/**
-    constructor(){
+ * allows to specify an user interaction during runtime
-        
+ */
+
+export type questionType = "input" | "confirm" | "list" | "rawlist" | "expand" | "checkbox" | "password" | "editor"
+export interface choiceObject {
+    name: string;
+    value: any
+}
+export interface validateFunction {
+    (any):boolean
+}
+
+export class Interaction {
+    constructor() {
+    };
+
+    askQuestion(optionsArg: {
+        type: questionType,
+        message: string
+        default: any
+        choices: string[] | choiceObject[];
+        validate: validateFunction
+    }) {
+        let done = plugins.q.defer();
+        plugins.inquirer.prompt([{
+            type: optionsArg.type,
+            message: optionsArg.message,
+            default: optionsArg.default,
+            choices:optionsArg.choices,
+            validate: optionsArg.validate
+        }]).then(answers => {
+            done.resolve(answers);
+        });
+    };
+    askQuestionArray
+}
+
+
+export class QuestionTree {
+
+    constructor(questionString: string, optionsArray) {
+
+    };
+};
+
+export class QuestionTreeNode {
+    constructor() {
+
+    }
+};
+
+export class QuestionStorage {
+    constructor() {
+
     }
 }

ts/smartcli.classes.smartcli.ts

@@ -1,17 +1,29 @@
 import "typings-global";
 
 import * as plugins from "./smartcli.plugins";
-import {Question} from "./smartcli.classes.interaction";
+import * as interaction from "./smartcli.classes.interaction";
+
+// import classes
+import {Objectmap} from "lik";
+
+// interfaces
+export interface commandPromiseObject {
+    commandName:string;
+    promise: plugins.q.Promise<any>;
+};
 
 export class Smartcli {
-    argv;
+    argv:any;
     questionsDone;
     parseStarted;
     commands;
     questions;
     version:string;
+
+    // maps
+    allCommandPromises = new Objectmap<commandPromiseObject>();
     constructor(){
-        this.argv = plugins.argv;
+        this.argv = plugins.yargs;
         this.questionsDone = plugins.q.defer();
         this.parseStarted = plugins.q.defer();
     };
@@ -44,15 +56,28 @@ export class Smartcli {
     /**
      * gets a Promise for a command word
      */
-    getCommandPromise(commandNameArg){
+    getCommandPromiseByName(commandNameArg:string){
-        //TODO
+        return this.allCommandPromises.find(commandPromiseObjectArg => {
-    }
+            return commandPromiseObjectArg.commandName === commandNameArg;
-    addQuestion(definitionArg:{questionString:string,questionType:string}){
+        }).promise;
-        
     };
-    addHelp(){
 
-    }
+    /**
+     * allows to specify help text to be printed above the rest of the help text
+     */
+    addHelp(optionsArg:{
+        helpText:string
+    }){
+        this.addCommand({
+            commandName:"help"
+        }).then(argvArg => {
+            plugins.beautylog.log(optionsArg.helpText);
+        })
+    };
+
+    /**
+     * specify version to be printed for -v --version
+     */
     addVersion(versionArg:string){
         this.version = versionArg;
         this.addAlias("v","version");
@@ -62,7 +87,11 @@ export class Smartcli {
                     console.log(this.version);
                 }
             })
-    }
+    };
+
+    /**
+     * returns promise that is resolved when no commands are specified
+     */
     standardTask(){
         let done = plugins.q.defer();
         this.parseStarted.promise
@@ -75,6 +104,10 @@ export class Smartcli {
             });
         return done.promise;
     }
+
+    /**
+     * start the process of evaluating commands
+     */
     startParse(){
         this.argv = this.argv.argv;
         this.parseStarted.resolve();

ts/smartcli.plugins.ts

@@ -1,10 +1,10 @@
 import "typings-global";
 
-export let argv = require('yargs');
+export import yargs = require('yargs');
 export import beautylog = require("beautylog");
-export let cliff = require("cliff");
+export import cliff = require("cliff");
-export let inquirer = require("inquirer");
+export import inquirer = require("inquirer");
 export import lik = require("lik");
-export let path = require("path");
+export import path = require("path");
 export import q = require("q");
 export import smartparam = require("smartparam");