Merge pull request #132 from cellsjs/feature/dynamic_type_inquirer

sbonacho · web-flow · commit 130a884310e6 · 2016-07-06T14:02:00.000+02:00
Feature/dynamic type inquirer
diff --git a/README.md b/README.md
@@ -34,93 +34,89 @@ So, you can use all your favorites tools keeping it under control and versioned.
 * [Complete documentation](doc/README.md) - Complete documentation, howtos, api, examples...
 * [Spanish documentation](doc/spanish/README.md) - Spanish documentation for piscosour.
 
-# Installing piscosour
 
-Install piscosour globally
+# Index: 'piscosour'
 
-    npm install -g piscosour
+- [ Commands Availables](#commands-availables)
+- [Plugins](#plugins)
+- [Contexts](#recipes)
+- [Recipes](#recipes)
 
 
-# Recipes
 
+#  Commands Availables
 
-|Name|Version|Description|
-|---|---|---|
-|pisco-user|-|User Piscosour Recipe|
-|piscosour|0.6.5|Get all your devops tools wrapped-up!|
 
+## Index:
 
 
-# Commands
+- from **piscosour  v.0.6.8**
+    - straws
+        - [node-module:convert (Convert any module into a piscosour recipe)](#node-moduleconvert-convert-any-module-into-a-piscosour-recipe)
+        - [recipe:add-shot (Add a shot to a piscosour recipe)](#recipeadd-shot-add-a-shot-to-a-piscosour-recipe)
+        - [recipe:add-straw (Add a straw to a piscosour recipe)](#recipeadd-straw-add-a-straw-to-a-piscosour-recipe)
+        - [recipe:configure (Manage a piscosour recipe)](#recipeconfigure-manage-a-piscosour-recipe)
+        - [recipe:create (Starting a repository from scratch)](#recipecreate-starting-a-repository-from-scratch)
+        - [recipe:docs (Append documentation from info.md to readme.md of the recipe)](#recipedocs-append-documentation-from-info.md-to-readme.md-of-the-recipe)
+    - shots
+        - [all::npm (Checking all npm commands needed)](#allnpm-checking-all-npm-commands-needed)
+        - [node-module::convert (Convert any nodejs module into a piscosour recipe)](#node-moduleconvert-convert-any-nodejs-module-into-a-piscosour-recipe)
+        - [recipe::add-shots (Create new pisco shot inside this module)](#recipeadd-shots-create-new-pisco-shot-inside-this-module)
+        - [recipe::add-straws (Adding shot to a straw)](#recipeadd-straws-adding-shot-to-a-straw)
+        - [recipe::configure (Configure piscosour.json)](#recipeconfigure-configure-piscosour.json)
+        - [recipe::generate-docs (Generate one file per straw inside a directory)](#recipegenerate-docs-generate-one-file-per-straw-inside-a-directory)
+        - [recipe::scaffolding (Create a piscosour recipe from a scaffold template)](#recipescaffolding-create-a-piscosour-recipe-from-a-scaffold-template)
+        - [recipe::update (Update tool)](#recipeupdate-update-tool)
 
 
 
-**from piscosour  v.0.6.5:**
+## node-module:convert (Convert any module into a piscosour recipe)
 
-- **pisco node-module::convert** ( Convert any nodejs module into a piscosour recipe )
-- **pisco recipe::generate-docs** ( Generate one file per straw inside a directory )
-- **pisco all::npm** ( Checking all npm commands needed )
-- **pisco recipe::piscosour** ( Configure piscosour.json )
-- **pisco recipe::scaffolding** ( Create a piscosour recipe from a scaffold template )
-- **pisco recipe::shots** ( Create new pisco shot inside this module )
-- **pisco recipe::straws** ( Adding shot to a straw )
-- **pisco recipe::updateversion** ( Update tool )
-- **pisco recipe:add-shot** ( Add a shot to a piscosour recipe )
-- **pisco recipe:add-straw** ( Add a straw to a piscosour recipe )
-- **pisco recipe:config** ( Manage a piscosour recipe )
-- **pisco node-module:convert** ( Convert any module into a piscosour recipe )
-- **pisco recipe:create** ( Starting a repository from scratch )
-- **pisco recipe:docs** ( Append documentation from info.md to readme.md of the recipe )
+convert straw
 
+### 1. convert: 'Convert any nodejs module into a piscosour recipe'
+```
+Repository types:  node-module
+Recipes: piscosour (0.6.8)
+```
+shot convert
 
+## recipe:add-shot (Add a shot to a piscosour recipe)
 
-## add-shot: 'Add a shot'
-Add a shot to a piscosour recipe
 
 
-### 1. shots: 'Create new pisco shot inside this module'
+### 1. add-shots: 'Create new pisco shot inside this module'
 ```
 Repository types:  recipe
-Recipes: piscosour (0.6.5)
+Recipes: piscosour (0.6.8)
 ```
 shot shots
 
-## add-straw: 'Add straw'
-Add a straw to a piscosour recipe
+## recipe:add-straw (Add a straw to a piscosour recipe)
+
 
 
-### 1. straws: 'Adding shot to a straw'
+### 1. add-straws: 'Adding shot to a straw'
 ```
 Repository types:  recipe
-Recipes: piscosour (0.6.5)
+Recipes: piscosour (0.6.8)
 ```
 shot straws
 
-## config: 'Configure piscosour'
-Manage a piscosour recipe
+## recipe:configure (Manage a piscosour recipe)
+
 
 
-### 1. piscosour: 'Configure piscosour.json'
+### 1. configure: 'Configure piscosour.json'
 ```
 Repository types:  recipe
-Recipes: piscosour (0.6.5)
+Recipes: piscosour (0.6.8)
 ```
 shot piscosour
 
-## convert: 'Module to recipe'
-Convert any module into a piscosour recipe
+## recipe:create (Starting a repository from scratch)
 
 
-### 1. convert: 'Convert any nodejs module into a piscosour recipe'
-```
-Repository types:  node-module
-Recipes: piscosour (0.6.5)
-```
-shot convert
-
-## create: 'Create from scratch'
-Starting a repository from scratch
-
 - Pisco te preguntará por el nombre de la receta que quieres crear. Este será el nombre de tu paquete npm que usarás para compartir la funcionalidad y las herramientas que envuelvas. Introduce el nombre que más te guste.
 - Deberás introducir el comando que quieres usar para hacer correr los "straws" (flujos) que vas a introducir en este módulo.
 - También deberás introducir una breve descripción para tu módulo.
@@ -138,12 +134,12 @@ Listo! ya tienes tu primer ejecutable de pisco creado! pruebalo
 ### 1. scaffolding: 'Create a piscosour recipe from a scaffold template'
 ```
 Repository types:  recipe
-Recipes: piscosour (0.6.5)
+Recipes: piscosour (0.6.8)
 ```
 shot scaffolding
 
-## docs: 'Generate Documentation'
-Append documentation from info.md to readme.md of the recipe
+## recipe:docs (Append documentation from info.md to readme.md of the recipe)
+
 Command: **node bin/pisco.js recipe:docs**
 
 Generate documentation for your recipe.
@@ -157,7 +153,7 @@ Info.md is a regular md file, so you can use all the markdown specification. The
 ### 1. generate-docs: 'Generate one file per straw inside a directory'
 ```
 Repository types:  recipe
-Recipes: piscosour (0.6.5)
+Recipes: piscosour (0.6.8)
 ```
 shot generate-docs
 
@@ -499,7 +495,6 @@ By default this is the versions defined inside core:
 ```
     "versions": {
       "npm" : {
-        "disableCheck": true,
         "list": "npm list -g --depth 0",
         "regexp": "\\@(.*?)\\s"
       },    
@@ -520,7 +515,6 @@ By default this is the versions defined inside core:
 - **key** (for example 'java'): is the command that you need inside your shot.
 - **option**: (optional, default is '-v') if version is set the way to check this version.
 - **regexp**: (optional) if version is on a string the way to extract only the version. Overwrite version defined on piscosour.json
-- **disableCheck:** (optional) used by tools as npm that asume are allways installed.
 - **list:** (optional) command used to get a stdout to use the regexp function in orther to get the version of the item you want to check.
 
 ##### List tip
@@ -654,4 +648,12 @@ this is the file resulting of the execution: the mix of all system requirements
 ```
 ## test
 
-Testing plugin. NO FUNCTIONALITY.
+Testing plugin. NO FUNCTIONALITY.
+# Recipes
+
+
+|Name|Version|Description|
+|---|---|---|
+|piscosour|0.6.8|Get all your devops tools wrapped-up!|
+
+
diff --git a/plugins/inquirer/info.md b/plugins/inquirer/info.md
@@ -2,6 +2,30 @@
 
 This plugin use inquirer library [Inquirer documentation](https://www.npmjs.com/package/inquirer)
 
+set type 
+
+params.json
+```
+  "prompts": [
+    {
+      "type": "#setType()",
+      "name": "doDefault",
+      "required": true,
+      "message": "Do you want to set default repository type?"
+    }
+  ],
+```
+
+- '#' indicate that is necesary to use a function in the shot in order to resolve the type value.
+- '()' set that pisco needs to execute this function on order to get the value. 
+
+shot.js
+```
+  setType: function() {
+    return 'confirm';
+  },
+```
+
 #### this.inquire
 
 | Param | Description |
diff --git a/plugins/inquirer/plugin.js b/plugins/inquirer/plugin.js
@@ -1,6 +1,6 @@
 'use strict';
 
-var inquirer = require('inquirer');
+const inquirer = require('inquirer');
 
 module.exports = {
   description: 'Plugin inquirer',
@@ -14,35 +14,44 @@ module.exports = {
   addons: {
 
     inquire: function(name) {
-      var prompts = this.params[name];
+      const prompts = this.params[name];
 
-      var getValidate = function(prompt) {
+      const getValidate = function(prompt) {
         return function(userInput) {
           return userInput ? true : '"' + prompt.name + '" is required. ' + prompt.message;
         };
       };
 
-      var shotResolution = function(prompt, attr) {
-        if (prompt[attr] !== undefined && Object.prototype.toString.call(prompt[attr]) !== '[object Function]' && typeof prompt[attr] !== 'boolean' && prompt[attr].indexOf('#') === 0) {
-          var functionName = prompt[attr].replace('#', '');
-          var func = this.runner[functionName];
+      const shotResolution = function(prompt, attr) {
+        if (prompt[attr] !== undefined
+          && Object.prototype.toString.call(prompt[attr]) !== '[object Function]'
+          && typeof prompt[attr] !== 'boolean'
+          && prompt[attr].indexOf('#') === 0) {
+          let functionName = prompt[attr].replace('#', '');
+          let exec = false;
+          if (functionName.indexOf('(') !== 0) {
+            functionName = functionName.replace('()', '');
+            exec = true;
+          }
+          const func = this.runner[functionName];
           if (func) {
-            prompt[attr] = func;
+            prompt[attr] = exec ? func() : func;
           } else {
             prompt[attr] = undefined;
             this.logger.info('#yellow', 'WARNING', 'value', functionName, 'doesn\'t exists!! in this shot');
           }
         }
       }.bind(this);
 
-      var reqs = [];
+      const reqs = [];
 
       if (prompts) {
         prompts.forEach((prompt) => {
 
           shotResolution(prompt, 'when');
           shotResolution(prompt, 'validate');
           shotResolution(prompt, 'choices');
+          shotResolution(prompt, 'type');
           shotResolution(prompt, 'default');
 
           if (prompt.required && !prompt.validate) {
