0.1.0 released.

CHANGELOG.md

@@ -1,3 +1,11 @@
+0.1.0 / 2012-05-31
+==================
+* Renamed `copyFile()` to `copy()`. `copy()` can now copy directories (recursively) too.
+* Renamed `rmrf()` to `remove()`. 
+* `remove()` aliased with `delete()`.
+* Added `mkdirp` capabilities. Named: `mkdir()`. Hides Node.js native `mkdir()`.
+* Instead of exporting the native `fs` module with new functions, I now copy over the native methods to a new object and export that instead.
+
 0.0.4 / 2012-03-14
 ==================
 * Removed CoffeeScript dependency

README.md

@@ -1,36 +1,138 @@
-# Node.js: fs-extra
+Node.js: fs-extra
+=================
 
-This module simply patches the Node.js 'fs' object with extra methods.
+This module adds a few extra file system methods that aren't included in the native `fs` module. It is a drop in replacement for `fs`.
 
-## Installation
+Installation
+------------
 
     npm install --production fs-extra
 
-Make sure that you run the test script to verify that it works on your system.
+Usage
-Navigate to the directory for the module and run: `make test`
+-----
 
-## Usage
+```javascript
+var fs = require('fs-extra');
+```
+
+Naming
+------
+
+I put a lot of thought into the naming of these function. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:
+
+* https://github.com/jprichardson/node-fs-extra/issues/2
+* https://github.com/flatiron/utile/issues/11
+* https://github.com/ryanmcgrath/wrench-js/issues/29
+* https://github.com/substack/node-mkdirp/issues/17
+
+First, I believe that in as many cases as possible, the [Node.js naming schemes](http://nodejs.org/api/fs.html) should be chosen. However, there are problems with the Node.js own naming schemes.
+
+For example, `fs.readFile()` and `fs.readdir()`: the **F** is capitalized in *File* and the **d** is not capitalized in *dir*. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: `fs.mkdir()`, `fs.rmdir()`, `fs.chown()`, etc.
+
+We have a dilemma though. How do you consistently name methods perform the following POSIX commands: `cp`, `cp -r`, `mkdir -p`, and `rm -rf`?
+
+My perspective: when in doubt, err on the side of simplicity. Consider that for a moment. A directory is just a hierarchical grouping of directories and files. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too. 
+
+So, if you want to remove a file or a directory regardless of whether it has contents, just call `fs.remove(path)` or its alias `fs.delete(path)`. If you want to copy a file or a directory whether it has contents, just call `fs.copy(source, destination)`. If you want to create a directory regardless of whether its parent directories exist, just call `fs.mkdir(path)`. (Note: you can still use the native Node.js `fs.mkdir()` method by requiring `fs` and calling `mkdir` on that object)
+
+
+Compromise
+----------
+
+If you feel that this module should add functionality, please let me know. If you don't like the naming scheme, let me know that as well. I'm willing to work with the community so that we can develop a logical grouping of file system functions that aren't found Node.js.
+
+
+Methods
+-------
+
+**NOTE:** You can still use the native Node.js methods. They are copied over to `fs-extra`.
+
+### copy()
+
+Copy a file or directory. The directory can have contents. Like `cp -r`. There isn't a synchronous version implemented yet.
+
+Examples:
 
 ```javascript
-fs = require('fs-extra')
+var fs = require('fs-extra');
+
+fs.copy('/tmp/myfile', '/tmp/mynewfile', function(err){
+  if (err) {
+    console.error(err);
+  }
+  else {
+    console.log("success!")
+  }
+}); //copies file
+
+fs.copy('/tmp/mydir', '/tmp/mynewdir'function(err){
+  if (err) {
+    console.error(err);
+  }
+  else {
+    console.log("success!")
+  }
+}); //copies directory, even if it has subdirectories or files
 ```
 
-Note that you can still use all of the [vanilla Node.js file methods][1].
 
-## Methods
+### remove()
+
+Removes a file or directory. The directory can have contents. Like `rm -rf`.
+
+Alias: `delete()`.
+
+Examples:
 
 ```javascript
-fs.copyFileSync(srcFile, destFile) //synchronously copies a file
+var fs = require('fs-extra');
-fs.copyFile(srcFile, destFile, function(err)) //asynchronously copies a file
 
-fs.rmrfSync(dir) //recursively deletes directory, like rm -rf on Unix
+fs.remove('/tmp/myfile', function(err){
-fs.rmrf(dir, callback)  //asynchronous version as before
+  if (err) {
+    console.error(err);
+  }
+  else {
+    console.log("success!")
+  }
+});
+
+fs.removeSync('/home/jprichardson'); //I just deleted my entire HOME directory. 
 ```
 
+
+### mkdir()
+
+Creates a directory. If the parent hierarchy doesn't exist, it's created. Like `mkdir -p`.
+
+Examples:
+
+```javascript
+var fs = require('fs');
+var fse = require('fs-extra');
+
+fse.mkdir('/tmp/some/long/path/that/prob/doesnt/exist', function(err){
+  if (err) {
+    console.error(err);
+  }
+  else {
+    console.log("success!")
+  }
+});
+
+fse.mkdirSync('/tmp/another/path');
+
+//now use Node.js native mkdir()
+
+fs.mkdir('/tmp/node/cant/do/this', function(err){
+  console.log('this wasnt successful');
+});
+
+
 ## License
 
-Dual licensed under MIT and Apache v2
+Licensed under MIT
 
 Copyright (c) 2011-2012 JP Richardson
 
-[1]: http://nodejs.org/docs/latest/api/fs.html 
+[1]: http://nodejs.org/docs/latest/api/fs.html 
+

lib/index.js

@@ -1,10 +1,19 @@
 (function() {
-  var copy, fs, path, remove;
+  var copy, fs, fse, key, mkdir, path, remove, val;
 
   fs = require('fs');
 
   path = require('path');
 
+  fse = {};
+
+  for (key in fs) {
+    val = fs[key];
+    if (typeof val === 'function') fse[key] = val;
+  }
+
+  fs = fse;
+
   copy = require('./copy');
 
   fs.copy = copy.copy;
@@ -15,6 +24,16 @@
 
   fs.removeSync = remove.removeSync;
 
+  fs["delete"] = fs.remove;
+
+  fs.deleteSync = fs.deleteSync;
+
+  mkdir = require('./mkdir');
+
+  fs.mkdir = mkdir.mkdir;
+
+  fs.mkdirSync = mkdir.mkdirSync;
+
   if (!(fs.exists != null)) fs.exists = path.exists;
 
   if (!(fs.existsSync != null)) fs.existsSync = path.existsSync;

package.json

@@ -9,14 +9,13 @@
         "type" : "git", 
         "url" : "https://github.com/jprichardson/node-fs-extra"
     },
-    "keywords" : ["fs","file","file system", "copy", "directory", "extra"],
+    "keywords" : ["fs","file","file system", "copy", "directory", "extra", "mkdirp", "recursive"],
     "author" : "JP Richardson <jprichardson@gmail.com>",
     "licenses" : [ {
         "type" : "MIT",
         "url" : "http://github.com/jprichardson/node-fs-extra/raw/master/LICENSE"
     }],
     "dependencies" : {
-        "path-extra": "0.0.x",
         "rimraf": "1.0.x",
         "ncp": "0.2.x",
         "mkdirp": "0.3.x"
@@ -25,7 +24,8 @@
         "mocha": "1.0.x",
         "growl": "1.5.x",
         "coffee-script": "1.2.x",
-        "test-util": "0.1.x"
+        "test-util": "0.1.x",
+        "path-extra": "0.0.x"
     },
     "main" : "./lib/index"
 }

src/index.coffee

@@ -1,17 +1,27 @@
 fs = require('fs')
 path = require('path')
 
+fse = {}
+
+for key,val of fs
+  if typeof val is 'function'
+    fse[key] = val
+
+fs = fse
+
 #fs-extra
 copy = require('./copy')
-#fs.copyFileSync = copy.copyFileSync
-#fs.copyFile = copy.copyFile
 fs.copy = copy.copy
 
 remove = require('./remove')
-#fs.rmrfSync = remove.rmrfSync
-#fs.rmrf = remove.rmrf
 fs.remove = remove.remove
 fs.removeSync = remove.removeSync
+fs.delete = fs.remove
+fs.deleteSync = fs.deleteSync
+
+mkdir = require('./mkdir')
+fs.mkdir = mkdir.mkdir
+fs.mkdirSync = mkdir.mkdirSync
 
 #make compatible for Node v0.8
 if not fs.exists?

test/mkdir.test.coffee

@@ -16,9 +16,9 @@ describe 'fs-extra', ->
       dir = path.join(path.tempdir(), 'tmp-' + Date.now() + Math.random())
       newDir = path.join(dir, 'dfdf', 'ffff', 'aaa')
       F fs.existsSync dir
-      fs.mkdir dir, (err) ->
+      fs.mkdir newDir, (err) ->
         T err is null
-        T fs.existsSync dir
+        T fs.existsSync newDir
         done()
 
   describe '+ mkdirSync()', ->
@@ -33,7 +33,6 @@ describe 'fs-extra', ->
       dir = path.join(path.tempdir(), 'tmp-' + Date.now() + Math.random())
       newDir = path.join(dir, 'dfdf', 'ffff', 'aaa')
       F fs.existsSync dir
-      fs.mkdir dir, (err) ->
+      fs.mkdirSync dir 
-        T err is null
+      T fs.existsSync dir
-        T fs.existsSync dir
+      done()
-        done()