Recursive file operations in Node.js
This repository has been archived on 2026-03-31. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
Find a file
Ryan McGrath 43ffe0e979 Merge pull request #10 from geddesign/master
added failSilent option to rmdirSyncRecursive
2012-01-10 16:44:22 -08:00
lib removed redundant variable 2012-01-10 12:41:04 -07:00
tests adding nodeunit test for issue #7 2011-10-23 15:48:43 +08:00
LICENSE Fix year... 2010-10-22 12:43:32 -04:00
package.json Version bump for npm 2011-11-04 11:47:25 +09:00
readme.md Updated readme examples with new mkdirSyncRecursive() stuff, version bump/publish 2011-10-23 16:56:28 +09:00

wrench.js - Recursive file operations in Node.js

While I love Node.js, I've found myself missing some functions. Things like recursively deleting/chmodding a directory (or even deep copying a directory), or even a basic line reader, shouldn't need to be re-invented time and time again.

That said, here's my attempt at a re-usable solution, at least until something more formalized gets integrated into Node.js (hint hint). wrench.js is fairly simple to use - check out the documentation/examples below:

Installation

npm install wrench

Usage

var wrench = require('wrench'),
	util = require('util');

// Recursively create directories, sub-trees and all.
wrench.mkdirSyncRecursive(dir, 0777);

// Recursively delete the entire sub-tree of a directory, then kill the directory
wrench.rmdirSyncRecursive('my_directory_name');

// Recursively chmod the entire sub-tree of a directory
wrench.chmodSyncRecursive('my_directory_name', 0755);

// Recursively chown the entire sub-tree of a directory
wrench.chownSyncRecursive("directory", uid, gid);

// Deep-copy an existing directory
wrench.copyDirSyncRecursive('directory_to_copy', 'location_where_copy_should_end_up');

// Read lines in from a file until you hit the end
var f = new wrench.LineReader('x.txt');
while(f.hasNextLine()) {
	util.puts(x.getNextLine());
}

It should be noted that these are all currently synchronous operations.

Questions, comments? Hit me up. (ryan [at] venodesigns.net | http://twitter.com/ryanmcgrath)