New: Add support for a filter function & update project structure (closes #1)

Author: jonschlinkert

.npmignore

@@ -3,6 +3,8 @@
 
 [![NPM](https://nodei.co/npm/empty-dir.png)](https://nodei.co/npm/empty-dir/)
 
+Note that directories with `.DS_Store` on mac are considered empty.
+
 ## Example
 ```js
 const emptyDir = require('empty-dir');
@@ -17,7 +19,31 @@ emptyDir('./', function (err, result) {
 
 var result = emptyDir.sync('./test/empty');
 console.log('Directory is empty:', result);
+```
+
+**Filter function**
+
+Both async and sync take a filter function as the second argument. 
+
+_(This gives you the ability to eliminate files like `.DS_Store` on mac, or `Thumbs.db` on windows from causing the result to be "not empty" (`.DS_Store` is already filtered by default).)_
+
+```js
+const emptyDir = require('empty-dir');
+
+function filter(filepath) {
+  return !/Thumbs\.db$/i.test(filepath);
+}
 
+emptyDir('./', filter, function (err, result) {
+  if (err) {
+    console.error(err);
+  } else {
+    console.log('Directory is empty:', result);
+  }
+});
+
+var result = emptyDir.sync('./test/empty', filter);
+console.log('Directory is empty:', result);
 ```
 
 ## Release History

README.md

@@ -1,18 +1,47 @@
 const fs = require('fs');
+const tryOpen = require('try-open');
 
-function isEmpty (path, callback) {
-  fs.readdir(path, function (err, files) {
-    if (err === null) {
-      callback(null, !!!files.length)
-    } else {
+function isEmpty(path, fn, callback) {
+  if (arguments.length === 2) {
+    callback = fn;
+    fn = null;
+  }
+
+  if (!exists(path)) {
+    callback(null, false);
+    return;
+  }
+
+  fs.readdir(path, function(err, files) {
+    if (err) {
       callback(err);
+      return;
+    }
+
+    if (typeof fn === 'function') {
+      files = files.filter(fn);
     }
+
+    callback(null, files.length === 0);
   });
 };
 
-isEmpty.sync = function (path) {
-  var files = fs.readdirSync(path);
-  return !!!files.length;
+isEmpty.sync = function(path, fn) {
+  if (!exists(path)) {
+    return false;
+  }
+  try {
+    var files = fs.readdirSync(path);
+    if (typeof fn === 'function') {
+      files = files.filter(fn);
+    }
+    return files.length === 0;
+  } catch (err) {};
+  return false;
 };
 
+function exists(path) {
+  return path && typeof tryOpen(path, 'r') === 'number';
+}
+
 module.exports = isEmpty;

index.js

@@ -2,30 +2,23 @@
   "name": "empty-dir",
   "description": "Check if a directory is empty.",
   "version": "0.1.0",
-  "homepage": "https://github.com/tkellen/node-empty-dir",
-  "author": {
-    "name": "Tyler Kellen",
-    "url": "http://goingslowly.com/"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/tkellen/node-empty-dir.git"
-  },
+  "homepage": "https://github.com/tkellen/js-empty-dir",
+  "author": "Tyler Kellen <http://goingslowly.com/>",
+  "repository": "tkellen/js-empty-dir",
   "bugs": {
-    "url": "https://github.com/tkellen/node-empty-dir/issues"
+    "url": "https://github.com/tkellen/js-empty-dir/issues"
   },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://github.com/tkellen/node-empty-dir/blob/master/LICENSE"
-    }
-  ],
+  "license": "MIT",
   "main": "index.js",
+  "files": ["index.js"],
   "engines": {
     "node": ">= 0.8.0"
   },
   "scripts": {
-    "test": "mocha -R spec test"
+    "test": "mocha"
+  },
+  "dependencies": {
+    "try-open": "^0.1.0"
   },
   "devDependencies": {
     "chai": "~1.9.1",

package.json

@@ -9,16 +9,24 @@ try {
 describe('emptyDir', function () {
   it('should call back with true if a directory is empty', function (done) {
     expect(emptyDir.sync('./')).to.be.false;
-    emptyDir('./', function (err, result) {
-      expect(result).to.be.false;
+    emptyDir('./', function (err, empty) {
+      expect(empty).to.be.false;
+      done();
+    });
+  });
+
+  it('should be false if a directory does not exist', function (done) {
+    expect(emptyDir.sync('./foo/bar/baz')).to.be.false;
+    emptyDir('./foo/bar/baz', function (err, empty) {
+      expect(empty).to.be.false;
       done();
     });
   });
 
   it('should call back with false if a directory is not empty', function (done) {
     expect(emptyDir.sync('./test/empty')).to.be.true;
-    emptyDir('./test/empty', function (err, result) {
-      expect(result).to.be.true;
+    emptyDir('./test/empty', function (err, empty) {
+      expect(empty).to.be.true;
       done();
     });
   });