Recursively read a directory

Author: jonathanong

.gitignore

@@ -0,0 +1,71 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Node.js #
+###########
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+node_modules
+npm-debug.log
+
+# Components #
+##############
+
+/build
+/components
+
+# ImageMagick #
+###############
+
+*.cache
+*.mpc
+
+# Other #
+#########
+test/*.2
+test/*/*.2
+test/*.mp4
+test/images/originalSideways.jpg.2

.npmignore

@@ -0,0 +1 @@
+test/

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - "0.10"

Makefile

@@ -0,0 +1,12 @@
+BIN = ./node_modules/.bin/
+
+test:
+	@${BIN}mocha \
+		--reporter spec \
+		--require should \
+		--bail
+
+clean:
+	@rm -rf node_modules
+
+.PHONY: test clean

README.md

@@ -0,0 +1,54 @@
+# fs.readdirSyncRecursive [![Build Status](https://travis-ci.org/jonathanong/fs-readdir-recursive.png)](https://travis-ci.org/jonathanong/fs-readdir-recursive)
+
+Read a directory recursively.
+
+## Example
+
+```js
+var read = require('fs-readdir-recursive')
+read(__dirname) === [
+  'test/test.js',
+  'index.js',
+  'Makefile',
+  'package.json',
+  'README.md'
+]
+```
+
+## API
+
+### read(root [, filter])
+
+`root` is the directory you wish to scan. `filter` is an optional filter for the files. By default, filter is:
+
+```js
+function (x) {
+  return x[0] !== '.'
+}
+```
+
+Which basically just ignores `.` files.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Jonathan Ong [email protected]
+
+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.

index.js

@@ -0,0 +1,26 @@
+var fs = require('fs')
+var path = require('path')
+
+module.exports = read
+
+function read(root, filter, files, prefix) {
+  prefix = prefix || ''
+  files = files || []
+  filter = filter || noDotFiles
+
+  var dir = path.join(root, prefix)
+  if (fs.lstatSync(dir).isDirectory())
+    fs.readdirSync(dir)
+    .filter(filter)
+    .forEach(function (name) {
+      read(root, filter, files, path.join(prefix, name))
+    })
+  else
+    files.push(prefix)
+
+  return files
+}
+
+function noDotFiles(x) {
+  return x[0] !== '.'
+}

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "fs-readdir-recursive",
+  "description": "Recursively read a directory",
+  "version": "0.0.1",
+  "scripts": {
+    "test": "make test"
+  },
+  "devDependencies": {
+    "mocha": "*",
+    "should": "*"
+  },
+  "author": {
+    "name": "Jonathan Ong",
+    "email": "[email protected]",
+    "url": "http://jongleberry.com",
+    "twitter": "https://twitter.com/jongleberry"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jonathanong/fs-readdir-recursive.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jonathanong/fs-readdir-recursive/issues",
+    "email": "[email protected]"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">= 0.10"
+  }
+}

test/.ignore

@@ -0,0 +1,31 @@
+var path = require('path')
+
+var read = require('../')
+
+describe('fs.readdirSyncRecursive()', function () {
+  it('should work in the folder', function (done) {
+    var files = read(__dirname)
+
+    files.length.should.equal(1)
+    files[0].should.equal('test.js')
+
+    done()
+  })
+
+  it('should work at the root with a filter', function (done) {
+    var files = read(path.join(__dirname, '..'), function (name) {
+      return name[0] !== '.' && name !== 'node_modules'
+    })
+
+    files.length.should.equal(5)
+    files.sort().should.eql([
+      'test/test.js',
+      'index.js',
+      'Makefile',
+      'package.json',
+      'README.md'
+    ].sort())
+
+    done()
+  })
+})