node-fs-extra
Advanced tools
fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
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.
I got tired of including mkdirp, rimraf, and cp -r in most of my projects.
npm install --save fs-extra
fs-extra is a drop in replacement for native fs. All methods in fs are unmodified and attached to fs-extra.
You don't ever need to include the original fs module again:
var fs = require('fs') //this is no longer necessary
you can now do this:
var fs = require('fs-extra'); //var fs = require('fs')
or if you prefer to make it clear that you're using fs-extra and not fs, you may want
to do this:
//var fs = require('fs')
var fse = require('fs-extra')
you can also keep, both, but it's redundant:
var fs = require('fs')
, fse = require('fs-extra')
NOTE: You can still use the native Node.js methods. They are copied over to fs-extra.
Copy a file or directory. The directory can have contents. Like cp -r.
Sync: copySync()
Examples:
var fs = require('fs-extra');
fs.copy('/tmp/myfile', '/tmp/mynewfile', function(err){
if (err) return console.error(err);
console.log("success!")
}); //copies file
fs.copy('/tmp/mydir', '/tmp/mynewdir', function(err){
if (err) return console.error(err);
console.log("success!")
}); //copies directory, even if it has subdirectories or files
Creates a file. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOT MODIFIED.
Sync: createFileSync()
Example:
var fs = require('fs-extra')
var file = '/tmp/this/path/does/not/exist/file.txt'
fs.createFile(file, function(err) {
console.log(err); //null
//file has now been created, including the directory it is to be placed in
})
Creates a directory. If the parent hierarchy doesn't exist, it's created. Like mkdir -p.
Alias: mkdirp()
Sync: mkdirsSync() / mkdirpSync()
Examples:
var fs = require('fs-extra');
fs.mkdirs('/tmp/some/long/path/that/prob/doesnt/exist', function(err){
if (err) return console.error(err);
console.log("success!")
});
fs.mkdirsSync('/tmp/another/path');
Almost the same as writeFile, except that if the directory does not exist, it's created.
Sync: outputFileSync()
Example:
var fs = require('fs-extra')
var file = '/tmp/this/path/does/not/exist/file.txt'
fs.outputFile(file, 'hello!', function(err) {
console.log(err); //null
fs.readFile(file, 'utf8', function(err, data) {
console.log(data); //hello!
})
})
Almost the same as writeJson, except that if the directory does not exist, it's created.
Alias: `outputJSON()
Sync: outputJsonSync(), outputJSONSync()
Example:
var fs = require('fs-extra')
var file = '/tmp/this/path/does/not/exist/file.txt'
fs.outputJson(file, {name: 'JP'}, function(err) {
console.log(err); //null
fs.readJson(file, function(err, data) {
console.log(data.name); //'JP
})
})
Reads a JSON file and then parses it into an object. options are the same that you'd pass to fs.readFile.
Alias: readJSON()
Sync: readJsonSync(), readJSONSync()
Example:
var fs = require('fs-extra');
fs.readJson('./package.json', function(err, packageObj) {
console.log(packageObj.version); //0.1.3
});
Removes a file or directory. The directory can have contents. Like rm -rf.
Alias: delete()
Sync: removeSync() / deleteSync()
Examples:
var fs = require('fs-extra');
fs.remove('/tmp/myfile', function(err){
if (err) return console.error(err);
console.log("success!")
});
fs.removeSync('/home/jprichardson'); //I just deleted my entire HOME directory.
Writes an object to a JSON file. options are the same that you'd pass to fs.readFile.
Alias: writeJSON()
Sync: writeJsonSync(), writeJSONSync()
Example:
var fs = require('fs-extra');
fs.writeJson('./package.json', {name: 'fs-extra'}, function(err){
console.log(err);
});
This contains items that I'm considering doing. I'd love community feedback.
rimraf, ncp, and mkdirps code into this library. I'd like fs-extra to be a stable library that module authors
can depend upon. A bunch of other dependencies kinda sucks for modules/libraries. (I'm leaning against this now.)fse prefix instead of fs. This may encourage people to start using fse as a prefix and hence make their code clearer that they're not using the native fs. I'm very undecided on this one since fs-extra is a drop in replacement for the native fs. (I'm leaning against this now.)I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:
First, I believe that in as many cases as possible, the Node.js naming schemes 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 that perform the following POSIX commands: cp, cp -r, mkdir -p, and rm -rf?
My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. 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.mkdirs(path) or fs.mkdirp(path).
fs-extra wouldn't be possible without using the modules from the following authors:
If you want to contribute, please add a test. Also, don't change the version in package.json.
<your name here>Licensed under MIT
Copyright (c) 2011-2013 JP Richardson
FAQs
fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
The npm package node-fs-extra receives a total of 4,132 weekly downloads. As such, node-fs-extra popularity was classified as popular.
We found that node-fs-extra demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.