node-readfiles

node-readfiles

A lightweight node.js module to recursively read files in a directory.

Installation

npm install node-readfiles

Usage

You can safely add readfiles anywhere in your project.

var readfiles = require('node-readfiles');

readfiles(dir, [options], callback, [doneCallback])

Asynchronusly read the files in a directory

dir

A relative or absolute path of the directory to read files.

options

An optional object parameter with the following properties:

• reverse: a bollean value that reverses the order of the list of files before traversing them (defaults to false)
• filenameFormat: one of readfiles.FULL_PATH, readfiles.RELATIVE, or readfiles.FILENAME, wether the callback's returns the full-path, relative-path or only the filenames of the traversed files. (default is readfiles.RELATIVE)
• doneOnError: a bollean value wether to stop and trigger the "doneCallback" when an error occurs (defaults to true)
• filter: a string, or an array of strings of path expression that match the files being read (defaults to '**')
  • ? matches one character
  • * matches zero or more characters
  • ** matches zero or more 'directories' in a path
• readContents: a boolean value wether to read the file contents when traversing the files ^[1] (defaults to true)
• encoding: a string with the encoding used when reading a file (defaults to 'utf8')
• depth: an integer value which limits the number sub-directories levels to traverse for the given path where -1 is infinte, and 0 is none (defaults to -1)
• hidden: a boolean value wether to exclude hidden files prefixed with a . (defaults to true)

callback(err, filename, content, stat)

The callback function that is triggered everytime a file is read. If there's an error while reading the file the err parameter will contain the error that occured, otherwise the if readContents is true, the contents parameter will be populated with the contents of the file encoded using the encoding option.

[1] The contents parameter will be null when the readContents option is false.

doneCallback(err, files, count)

The callback function that is triggered once all the files have been read, passing the number of files read and an array with the full path of all files.

Examples

The default behavior, is to recursively list all files in a directory. By default readfiles will exclude all dot files.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', function (err, filename, contents) {
  if (err) throw err;
  console.log('File ' + filename + ':');
  console.log(content);
}, function (err, count, files) {
  console.log('Read ' + count + ' file(s)');
  console.log(files.join('\n'));
});

Read all files in a directory, excluding sub-directories.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', {
  depth: 0
}, function (err, content, filename) {
  if (err) throw err;
  console.log('File ' + filename + ':');
  console.log(content);
}, function (err, count, files) {
  console.log('Read ' + count + ' file(s)');
  console.log(files.join('\n'));
});

The above can also be accomplished using filter.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', {
  filter: '*' // instead of the default '**'
}, function (err, content, filename) {
  if (err) throw err;
  console.log('File ' + filename + ':');
  console.log(content);
}, function (err, count, files) {
  console.log('Read ' + count + ' file(s)');
  console.log(files.join('\n'));
});

Recursively read all files with "txt" extension in a directory and display the contents.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', {
  filter: '*.txt'
}, function (err, content, filename) {
  if (err) throw err;
  console.log('File ' + filename + ':');
  console.log(content);
}, function (err, count, files) {
  console.log('Read ' + count + ' text file(s)');
});

Recursively read all files with that match "t?t" in a directory and display the contents.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', {
  filter: '*.t?t'
}, function (err, content, filename) {
  if (err) throw err;
  console.log('File ' + filename + ':');
  console.log(content);
}, function (err, count, files) {
  console.log('Read ' + count + ' text file(s)');
});

Recursively list all json files in a directory including all sub-directories, without reading the files.

var readfiles = require('readfiles');

readfiles('/path/to/dir/', {
  filter: '*.json',
  readContents: false
}, function (err, content, filename) {
  if (err) throw err;
  console.log('File ' + filename);
});

License

MIT licensed (See LICENSE.txt)