0.0.9

Update beautylog to version 0.0.15 🚀

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 .settings/
-.idea/
+.idea/
+
+ts/*.js
+ts/*.js.map

.travis.yml

@@ -1,19 +1,20 @@
 language: node_js
 before_install:
-  - nvm install stable
+- nvm install stable
-  - node -v
+- node -v
-  - npm -v
+- npm -v
-  - npm install -g gulp
+- npm install -g gulp
-  - npm install gulp
+- npm install gulp
-  - npm install gulp-typescript
+- npm install gulp-typescript
 deploy:
   provider: npm
   email: npm@smart-coordination.com
   api_key:
-    secure: y7l1JyBDihAYxbqfuPAUXJfY+PC7RSSCkAtXtBIjPA6wytSBnz55te/Vdy8RFgVty6O/k4hHzrhgUJMSoWKmPuGQ5bMBgkyV9OI5PPp4uEUyy5UdcJZv3cZYpGGDRjLjCHP4pF7AHdRcDUMEiE5ZrDtmUH1SBLoRswieO0TKsiMr3u45yR6rHFoPnnw1YlatoAPpiuP3SLnCrIjQeSOS7y9SL6PpakiquJNtpseVOr60sp39L6vLAeqJ7xTjjNJk23LF/60lfiKtM7QFg9qqE7cxFUWJs7Zmgfg4/hGcU9XRfDfZQgSNntcdFczPejO5juv2KOb1tzH7EhXrWlcF1yd70RBdJbcOn7O6ctHjMCGrCSn6IQPzcNWNErFELfMLsjVQUxbfHSc0iA1JxcYWeXUivrStwVOa9ufuG2KZCQZyEjra3zPdCu9yrE30c/mTace7eJXPYTsNn2tmxvTnFoTWmeQ0xL9Iyz9zceADpxjYJoJ8r4XMDWxWga5G9OPaqCINHxjKhOX0C36YEjYTaeNMNHv6F6BPLdKwQ9SmklMtcyC312nJsXwKy+KYJSoY6WqMef9Zk3ez0o09W0UkSr0qiQkyYCoNm8b1L7VrYuccPH24GE0fn8QMWmeE5TBThYbEIdt6NBoYCDeocflUm5KBrImFGo1peeYS1aQnpoQ=
+    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/gulp-bootstrap
+    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=
+  email: false

README.md

@@ -1,16 +1,31 @@
 # smartcli
-nodejs wrapper for CLI related tasks
+nodejs wrapper for CLI related tasks  
+[![Dev Status](https://img.shields.io/badge/DevStatus-Active-green.svg)](https://github.com/pushrocks/smartcli/commits/dev)
 
 ### 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)
 
-### Usage
+### Install the package
-This npm package comes with everything you need to start your own gulp plugin.
+    npm install smartcli
 
-We recommend modifying the ts/index.ts file, 
+### Usage
-then run `npm install` to install the dev dependencies
+```js
-and use `npm test` to compile the TypeScript file.
+var smartcli = require("smartcli");
- 
+
-Cheers  
+//returns true for terminal command "node myjs.js jazz"
+smartcli.checkCommand('jazz'); 
+
+/**
+* returns an object for terminal command "node myjs.js --myoption something like so
+* {
+*   name: 'myoption',
+*   specified: true,
+*   value: 'something'
+* }
+*/
+smartcli.getOption('myoption');
+``
+
+Cheers
 Phil from Lossless Digital

index.js

@@ -1,11 +1,113 @@
+/// <reference path="index.ts" />
 /// <reference path="typings/tsd.d.ts" />
-var path, through;
+/// <reference path="./interfaces.ts" />
-through = require("through2");
+var path = require("path");
-path = require("path");
+var beautylog = require("beautylog");
-module.exports = function (jadeTemplate, mojo) {
+var cliff = require("cliff");
-    if (mojo === void 0) { mojo = undefined; }
+var inquirer = require("inquirer");
-    return through.obj(function (file, enc, cb) {
+var argv = require('yargs').argv;
-        //run callback function to signal end of plugin process.
+//define the smartcli object
-        return cb(null, file);
+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.getOption = function (optionName) {
+    if (argv.hasOwnProperty(optionName)) {
+        return {
+            name: optionName,
+            specified: true,
+            value: argv[optionName] //we already know from the "if" above that the value is available.
+        };
+    }
+    return {
+        name: optionName,
+        specified: false,
+        value: false
+    };
+};
+smartcli.getOptions = function () {
+    var options = {};
+    for (var key in argv) {
+        if (key != "_") {
+            options['key'] = argv['key'];
+        }
+    }
+    return options;
+};
+/**
+ * returns Directory of cwd
+ * @returns {{path: string}}
+ */
+smartcli.getCwd = function () {
+    return {
+        path: 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;

package.json

@@ -1,17 +1,18 @@
 {
   "name": "smartcli",
-  "version": "0.0.2",
+  "version": "0.0.9",
   "description": "nodejs wrapper for CLI related tasks",
   "main": "index.js",
   "scripts": {
     "test": "(cd ts/compile && gulp)",
+    "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/gulp-bootstrap.git"
+    "url": "https://github.com/pushrocks/smartcli.git"
   },
   "keywords": [
     "json",
@@ -21,10 +22,15 @@
   "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/gulp-bootstrap/issues"
+    "url": "https://github.com/pushrocks/smartcli/issues"
+  },
+  "homepage": "https://github.com/pushrocks/smartcli",
+  "dependencies": {
+    "beautylog": "0.0.15",
+    "cliff": "^0.1.10",
+    "inquirer": "^0.10.1",
+    "yargs": "^3.26.0"
   },
-  "homepage": "https://github.com/pushrocks/gulp-bootstrap",
-  "dependencies": {},
   "devDependencies": {
     "gulp": "3.9.0",
     "gulp-typescript": "2.9.2"

test.js

@@ -0,0 +1,45 @@
+/// <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);
+var getCwdTest = function () {
+    console.log('The current directory is: ' + smartcli.getCwd().path);
+};
+var checkCommandTest = function () {
+    if (smartcli.checkCommand('jazz')) {
+        bl.log('One of your commands is jazz');
+    }
+    else {
+        bl.log('None of your commands is jazz');
+    }
+};
+var getOptionTest = function () {
+    console.log('We now test for option --test');
+    console.log(smartcli.getOption('test'));
+};
+var checkOptionTest = function () {
+};
+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);
+    });
+};
+//starting command tests
+getCwdTest();
+checkCommandTest();
+getOptionTest();
+//starting first interaction test (the other tests are then started via callbacks)
+getAnswerTest();

ts/compile/compile.sh

@@ -1,2 +0,0 @@
-nvm use v0.12.7
-gulp

ts/compile/gulpfile.js

@@ -11,6 +11,15 @@ gulp.task('compileTS', function() {
 	return stream;
 });
 
-gulp.task('default',['compileTS'], function() {
+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/index.ts

@@ -1,14 +1,139 @@
 /// <reference path="typings/tsd.d.ts" />
-var path, through;
+/// <reference path="./interfaces.ts" />
 
-through = require("through2");
+var path = require("path");
-path = require("path");
+var beautylog = require("beautylog");
+var cliff = require("cliff");
+var inquirer = require("inquirer");
+var argv = require('yargs').argv;
 
-module.exports = (jadeTemplate,mojo = undefined) => {
+//define the smartcli object
+var smartcli:any = {};
 
-    return through.obj((file, enc, cb) => {
+//add plugins from above for direct use
-        
+smartcli.inquirer = inquirer;
-        //run callback function to signal end of plugin process.
+smartcli.cliff = cliff;
-        return cb(null, file);
+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.getOption = function(optionName:string):CliOption {
+    if (argv.hasOwnProperty(optionName)) {
+        return {
+            name:optionName,
+            specified: true,
+            value: argv[optionName] //we already know from the "if" above that the value is available.
+        };
+
+    }
+    return {
+        name:optionName,
+        specified: false,
+        value: false
+    }
+};
+
+
+smartcli.getOptions = function() {
+    var options = {};
+    for (var key in argv) {
+        if (key != "_") {
+            options['key'] = argv['key'];
+        }
+    }
+    return options;
+};
+
+/**
+ * returns Directory of cwd
+ * @returns {{path: string}}
+ */
+smartcli.getCwd = function():Directory {
+    return {
+        path: 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;

ts/interfaces.ts

@@ -0,0 +1,11 @@
+/// <reference path="index.ts" />
+interface CliOption {
+    name: string;
+    specified:boolean;
+    value: any;
+}
+
+interface Directory {
+    path: string;
+}
+

ts/test.ts

@@ -0,0 +1,58 @@
+/// <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);
+
+
+var getCwdTest = function(){
+    console.log('The current directory is: ' + smartcli.getCwd().path);
+};
+
+var checkCommandTest = function() {
+    if (smartcli.checkCommand('jazz')) {
+        bl.log('One of your commands is jazz');
+    } else {
+        bl.log('None of your commands is jazz');
+    }
+};
+
+var getOptionTest = function() {
+    console.log('We now test for option --test')
+    console.log(smartcli.getOption('test'));
+}
+
+var checkOptionTest = function() {
+
+};
+
+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);
+    });
+};
+
+
+
+//starting command tests
+getCwdTest();
+checkCommandTest();
+getOptionTest();
+
+//starting first interaction test (the other tests are then started via callbacks)
+getAnswerTest();