Merge pull request #17 from wbinnssmith/wbinnssmith/promise-api

Use a Promise API instead of a callback.

Author: sindresorhus

index.js

@@ -1,9 +1,10 @@
 'use strict';
+var Promise = require('pinkie-promise');
 var arrayUnion = require('array-union');
 var objectAssign = require('object-assign');
-var async = require('async');
 var glob = require('glob');
 var arrify = require('arrify');
+var pify = require('pify');
 
 function sortPatterns(patterns) {
 	patterns = arrify(patterns);
@@ -38,37 +39,19 @@ function setIgnore(opts, negatives, positiveIndex) {
 	return opts;
 }
 
-module.exports = function (patterns, opts, cb) {
+module.exports = function (patterns, opts) {
 	var sortedPatterns = sortPatterns(patterns);
-
-	if (typeof opts === 'function') {
-		cb = opts;
-		opts = {};
-	}
+	opts = opts || {};
 
 	if (sortedPatterns.positives.length === 0) {
-		cb(null, []);
-		return;
+		return Promise.resolve([]);
 	}
 
-	async.parallel(sortedPatterns.positives.map(function (positive) {
-		return function (cb2) {
-			glob(positive.pattern, setIgnore(opts, sortedPatterns.negatives, positive.index), function (err, paths) {
-				if (err) {
-					cb2(err);
-					return;
-				}
-
-				cb2(null, paths);
-			});
-		};
-	}), function (err, paths) {
-		if (err) {
-			cb(err);
-			return;
-		}
-
-		cb(null, arrayUnion.apply(null, paths));
+	return Promise.all(sortedPatterns.positives.map(function (positive) {
+		var globOpts = setIgnore(opts, sortedPatterns.negatives, positive.index);
+		return pify(glob, Promise)(positive.pattern, globOpts);
+	})).then(function (paths) {
+		return arrayUnion.apply(null, paths);
 	});
 };
 

package.json

@@ -53,9 +53,10 @@
   "dependencies": {
     "array-union": "^1.0.1",
     "arrify": "^1.0.0",
-    "async": "^1.2.1",
     "glob": "^5.0.3",
-    "object-assign": "^3.0.0"
+    "object-assign": "^3.0.0",
+    "pify": "^1.0.0",
+    "pinkie-promise": "^1.0.0"
   },
   "devDependencies": {
     "glob-stream": "wearefractal/glob-stream#master",

readme.md

@@ -1,6 +1,6 @@
 # globby [![Build Status](https://travis-ci.org/sindresorhus/globby.svg?branch=master)](https://travis-ci.org/sindresorhus/globby)
 
-> Extends [glob](https://github.com/isaacs/node-glob) with support for multiple patterns
+> Extends [glob](https://github.com/isaacs/node-glob) with support for multiple patterns and exposes a Promise API
 
 
 ## Install
@@ -30,7 +30,7 @@ globby(['*', '!cake'], function (err, paths) {
 
 ## API
 
-### globby(patterns, [options], callback)
+### globby(patterns, [options])
 
 ### globby.sync(patterns, [options])
 
@@ -47,8 +47,8 @@ Type: `object`
 
 See the node-glob [options](https://github.com/isaacs/node-glob#options).
 
-#### callback(err, paths)
-
+`globby.sync` synchronously returns an array of paths matching the glob expression.
+`globby` returns a Promise object that resolves to an array of matching paths or is rejected with an error.
 
 ## Globbing patterns
 

test.js

@@ -22,27 +22,21 @@ after(function () {
 	fixture.forEach(fs.unlinkSync.bind(fs));
 });
 
-it('should glob - async', function (cb) {
-	globby('*.tmp', function (err, paths) {
-		assert(!err, err);
+it('should glob - async', function () {
+	return globby('*.tmp').then(function (paths) {
 		assert.deepEqual(paths, ['a.tmp', 'b.tmp', 'c.tmp', 'd.tmp', 'e.tmp']);
-		cb();
 	});
 });
 
-it('should glob with multiple patterns - async', function (cb) {
-	globby(['a.tmp', '*.tmp', '!{c,d,e}.tmp'], function (err, paths) {
-		assert(!err, err);
+it('should glob with multiple patterns - async', function () {
+	return globby(['a.tmp', '*.tmp', '!{c,d,e}.tmp']).then(function (paths) {
 		assert.deepEqual(paths, ['a.tmp', 'b.tmp']);
-		cb();
 	});
 });
 
-it('should respect patterns order - async', function (cb) {
-	globby(['!*.tmp', 'a.tmp'], function (err, paths) {
-		assert(!err, err);
+it('should respect patterns order - async', function () {
+	return globby(['!*.tmp', 'a.tmp']).then(function (paths) {
 		assert.deepEqual(paths, ['a.tmp']);
-		cb();
 	});
 });
 
@@ -52,18 +46,25 @@ it('should glob - sync', function () {
 	assert.deepEqual(globby.sync(['!*.tmp', 'a.tmp']), ['a.tmp']);
 });
 
+it('should return [] for all negative patterns - sync', function () {
+	assert.deepEqual(globby.sync(['!a.tmp', '!b.tmp']), []);
+})
+
+it('should return [] for all negative patterns - async', function () {
+	return globby(['!a.tmp', '!b.tmp']).then(function (paths) {
+		assert.deepEqual(paths, []);
+	});
+})
+
 it('cwd option', function () {
 	process.chdir('tmp');
 	assert.deepEqual(globby.sync('*.tmp', {cwd: cwd}), ['a.tmp', 'b.tmp', 'c.tmp', 'd.tmp', 'e.tmp']);
 	assert.deepEqual(globby.sync(['a.tmp', '*.tmp', '!{c,d,e}.tmp'], {cwd: cwd}), ['a.tmp', 'b.tmp']);
 	process.chdir(cwd);
 });
 
-it('should not mutate the options object - async', function (cb) {
-	globby(['*.tmp', '!b.tmp'], Object.freeze({ignore: Object.freeze([])}), function (err, paths) {
-		assert(!err, err);
-		cb();
-	});
+it('should not mutate the options object - async', function () {
+	return globby(['*.tmp', '!b.tmp'], Object.freeze({ignore: Object.freeze([])}));
 });
 
 it('should not mutate the options object - sync', function () {