Merge pull request #44 from shannonlal/v-0-4-Templating

V 0 4 templating

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2017-10-07
+### Added
+- Added lodash templating @shannonlal
+
 ## [0.3.0] - 2017-09-28
 ### Added
 - Added unit testing @shannonlal

README.md

@@ -153,3 +153,21 @@ Example List Selection:
 
 ```
 
+Example Templating:
+This was a fix to the issue #8 (https://github.com/Freyskeyd/gulp-prompt/issues/8)
+[Note: see sample file]( examples/template-replacement-gulpfile.js)
+```javascript
+
+    return gulp.src( './package.json' )
+        .pipe( prompt.confirm({
+            type:'input',
+            name:'env',
+            message:'Hello <%= user %>, please enter selection?',
+            templateOptions:{ 'user': 'fred' }
+        }, (res) => {
+            console.log('Result', res);
+        }) );
+
+
+```
+

examples/template-replacement-gulpfile.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var gulp = require( 'gulp' );
+var prompt = require('../index');
+
+/**
+ * The following is a sample gulp file for using replacement from the command prompt
+ * Note: This replacement function is only available on the confirm operation.  
+ * This is uses lodash template module and does a basic replacement of one or more 
+ * variables
+ * 
+ * https://www.npmjs.com/package/lodash.template
+ */
+gulp.task( 'getConfirmWithReplacement',  () => {
+    return gulp.src( './package.json' )
+        .pipe( prompt.confirm({
+            type:'input',
+            name:'env',
+            message:'Hello <%= user %>, please enter selection?',
+            templateOptions:{ 'user': 'fred' }
+        }, (res) => {
+            console.log('Result', res);
+        }) );
+});
+

index.js

@@ -1,5 +1,6 @@
 var inq = require('inquirer'),
-  es  = require('event-stream');
+  es  = require('event-stream'),
+  template = require("lodash.template");
 
 module.exports = {
 
@@ -53,6 +54,11 @@ module.exports = {
         options = {};
       }
 
+      if( typeof options.templateOptions !== 'undefined'){
+        var compiled = template( options.message );
+        options.message = compiled( options.templateOptions);
+      }
+
       opts.message = options.message || opts.message;
       opts.default = options.default || opts.default;
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-prompt",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Add interactive console prompts to gulp",
   "main": "index.js",
   "scripts": {
@@ -16,7 +16,8 @@
   "license": "MIT",
   "dependencies": {
     "event-stream": "~3.0.20",
-    "inquirer": "^3.3.0"
+    "inquirer": "^3.3.0",
+    "lodash.template":"^4.4.0"
   },
   "devDependencies": {
     "assert": "^1.4.1",

test/confirm-spec.js

@@ -105,6 +105,88 @@ describe('gulp confirm function unit tests', function () {
         let resp = srcStream.pipe( gulpPrompt.confirm( options ) );
         resp.write('../test.txt');
     });
+
+    it('verify that lodash templates replacement works', function ( done ){
+        var prompt = function ( listOptions ){
+            return new Promise( (resolve,reject) => {
+                resolve('Test Completed');
+                if( Array.isArray( listOptions)  && typeof listOptions[0] !== 'string' ){
+                    assert.equal( listOptions[0].message, 'hello fred! what is your choice?' );
+                    done();
+                }else{
+                    console.log( 'Failed test');
+                    done('options defaults not set');
+                }
+            });
+        };
+
+        //Mock inquirer to capture response
+        let gulpPrompt = proxyrequire('../index.js', {'inquirer':{ prompt: prompt}});
+        let srcStream = source('../README.md');
+        let options = {
+            type: 'confirm',
+            name: 'val',
+            message: 'hello <%= user %>! what is your choice?',
+            templateOptions:{ 'user': 'fred' }
+        };
+        let resp = srcStream.pipe( gulpPrompt.confirm( options ) );
+        console.log('Executing test');
+        resp.write('../test.txt');
+    });
+
+    it('verify that lodash templates is only called when template options are defined', function ( done ){
+        var prompt = function ( listOptions ){
+            return new Promise( (resolve,reject) => {
+                resolve('Test Completed');
+                if( Array.isArray( listOptions)  && typeof listOptions[0] !== 'string' ){
+                    assert.equal( listOptions[0].message, 'hello <%= user %>! what is your choice?' );
+                    done();
+                }else{
+                    console.log( 'Failed test');
+                    done('options defaults not set');
+                }
+            });
+        };
+
+        //Mock inquirer to capture response
+        let gulpPrompt = proxyrequire('../index.js', {'inquirer':{ prompt: prompt}});
+        let srcStream = source('../README.md');
+        let options = {
+            type: 'confirm',
+            name: 'val',
+            message: 'hello <%= user %>! what is your choice?'
+        };
+        let resp = srcStream.pipe( gulpPrompt.confirm( options ) );
+        resp.write('../test.txt');
+    });
+
+    it('verify that lodash templates replacement works for two fields', function ( done ){
+        var prompt = function ( listOptions ){
+            return new Promise( (resolve,reject) => {
+                resolve('Test Completed');
+                if( Array.isArray( listOptions)  && typeof listOptions[0] !== 'string' ){
+                    assert.equal( listOptions[0].message, 'hello fred! what is today your choice?' );
+                    done();
+                }else{
+                    console.log( 'Failed test');
+                    done('options defaults not set');
+                }
+            });
+        };
+
+        //Mock inquirer to capture response
+        let gulpPrompt = proxyrequire('../index.js', {'inquirer':{ prompt: prompt}});
+        let srcStream = source('../README.md');
+        let options = {
+            type: 'confirm',
+            name: 'val',
+            message: 'hello <%= user %>! what is <%= date %> your choice?',
+            templateOptions:{ 'user': 'fred', 'date':'today' }
+        };
+        let resp = srcStream.pipe( gulpPrompt.confirm( options ) );
+        console.log('Executing test');
+        resp.write('../test.txt');
+    });
   });
 });