add main files

Author: stringparser

index.js

@@ -0,0 +1,37 @@
+'use strict';
+
+try {
+  var gulp = require('gulp');
+} catch (err){
+  var gutil = require('gulp-util');
+  gutil.log('gulp is not installed locally');
+  gutil.log('try `npm install gulp`');
+  process.exit(1);
+}
+
+var readline = require('readline');
+var completer = require('./lib/completer');
+
+// create a simple readline interface
+//
+gulp.repl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+  completer: function(line){
+    return completer(gulp, line);
+  }
+});
+
+// dispatch tasks only if line wasn't empty
+//
+gulp.repl.on('line', function(line){
+  line = line.trim();
+  if(!line){ return gulp.repl.prompt(); }
+  var runner = gulp.parallel || gulp.start;
+  var result = runner.apply(gulp, line.split(/[ ]+/));
+  if(typeof result === 'function'){ // gulp#4.0
+    result();
+  }
+});
+
+exports = module.exports = gulp;

lib/completer.js

@@ -0,0 +1,37 @@
+'use strict';
+
+// ## completer(line, callback)
+//
+// arguments
+//  - gulp, gulp instance
+//  - line, `string`, passed from readline's `line` event
+//  - callback, `function` passed from readline's
+//
+// returns undefined
+//
+// --
+// api.private
+// --
+
+function completer(gulp, line){
+  var completion;
+
+  if(gulp.tasks){ // gulp#3.x
+    completion = Object.keys(gulp.tasks);
+  } else if(gulp._registry && gulp._registry._tasks){ // gulp#4.0
+    completion = Object.keys(gulp._registry._tasks);
+  } else { completion = []; }
+
+  var match = line.match(/([ ]+|^)\S+$/);
+  line = line.substring(match.index, line.length).trim();
+
+  var hits = completion.filter(function(elem){
+    return !elem.indexOf(line);
+  });
+
+  // TODO: add async path completion
+  // read: nodejs.org/api/readline.html
+  return [hits.length ? hits : completion, line];
+}
+
+exports = module.exports = completer;

readme.md

@@ -0,0 +1,68 @@
+## gulp-repl [![build][b-build]][x-travis][![NPM version][b-version]][gulp-repl]
+
+### usage
+
+```js
+var gulp = require('gulp-repl');
+
+gulp.task('foo', function (cb) {
+	// do foo stuff
+	cb();
+});
+
+gulp.task('bar', function (cb) {
+	// do bar stuff
+	cb();
+});
+```
+
+then, on your terminal you'll have a repl. Press
+
+1. <kbd>Enter</kbd> to see the prompt
+1. write the tasks you want to run
+1. or <kbd>Tab</kbd> to see completion
+
+```
+$ gulp
+$ # some task logging here
+$ (press Enter)
+$ > foo bar
+[10:39:11] Starting 'foo'...
+[10:39:11] Finished 'foo' after 13 μs
+[10:39:11] Starting 'bar'...
+[10:39:11] Finished 'bar' after 5.52 μs
+```
+
+### API
+
+#### gulp.repl
+
+The module adds a `gulp.repl` property to the `gulp` instance. This
+property is a readline instance. [See node core `realine` module  documentation][readline] for more detail on its methods.
+
+### install
+
+```
+$ npm install --save-dev gulp-repl
+```
+
+### license
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Javier Carrillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+<!-- links -->
+
+[x-travis]: https://travis-ci.org/stringparser/gulp-repl/builds
+[b-build]: https://travis-ci.org/stringparser/gulp-repl.svg?branch=master
+[b-version]: http://img.shields.io/npm/v/gulp-repl.svg?style=flat-square
+
+[gulp-repl]: https://npmjs.com/gulp-repl
+[kramed-issues]: https://github.com/GitbookIO/kramed/issues

test/index.js

@@ -0,0 +1,19 @@
+'use strict';
+
+require('should');
+
+describe('gulp-repl', function(){
+  var gulp = require('../');
+
+  it('repl property that is a readline Interface', function(){
+    var readline = require('readline');
+    gulp.repl.constructor.should.be.eql(readline.Interface);
+  });
+
+  it('should dispatch registered tasks', function(done){
+    var one, two;
+    gulp.task('one', function(cb){ one = true; cb(); });
+    gulp.task('two', function(cb){ two = true; done(); cb(); });
+    gulp.repl.emit('line', 'one two');
+  });
+});