fs-extra contains methods that aren't included in the vanilla Node.js fs package. 

fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as recursive mkdir, copy, and remove.

jprichardson

ryanzim

manidlou

fs-extra

fs-extra contains methods that aren't included in the vanilla Node.js fs package.

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

* Fixed bug in `remove()`/`delete()` that wouldn't execute the function if a callback wasn't passed.

* Renamed `copyFile()` to `copy()`. `copy()` can now copy directories (recursively) too.

* 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.

  var BUF_LENGTH, copy, copyFile, copyFileSync, fs, ncp, _buff;

  copyFileSync = function(srcFile, destFile) {

      bytesRead = fs.readSync(fdr, _buff, 0, BUF_LENGTH, pos);

      fs.writeSync(fdw, _buff, 0, bytesRead);

  copyFile = function(srcFile, destFile, cb) {

    fdw = fs.createWriteStream(destFile);

  copy = function(source, dest, callback) {

  module.exports.copyFileSync = copyFileSync;

  var copy, fs, fse, key, mkdir, path, remove, val;

    if (typeof val === 'function') fse[key] = val;

  if (!(fs.exists != null)) fs.exists = path.exists;

  if (!(fs.existsSync != null)) fs.existsSync = path.existsSync;

  module.exports.mkdirSync = mkdirp.sync;

      return rimraf(dir, (function() {}));

    "description" : "fs-extra contains methods that aren't included in the vanilla Node.js fs package.",

        "https://github.com/jprichardson/node-fs-extra"

        "url" : "https://github.com/jprichardson/node-fs-extra"

    "keywords" : ["fs","file","file system", "copy", "directory", "extra", "mkdirp", "recursive"],

    "author" : "JP Richardson <jprichardson@gmail.com>",

        "url" : "http://github.com/jprichardson/node-fs-extra/raw/master/LICENSE"

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 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)

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.

**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`. There isn't a synchronous version implemented yet.

fs.copy('/tmp/myfile', '/tmp/mynewfile', function(err){

fs.copy('/tmp/mydir', '/tmp/mynewdir'function(err){

}); //copies directory, even if it has subdirectories or files

Removes a file or directory. The directory can have contents. Like `rm -rf`.

fs.removeSync('/home/jprichardson'); //I just deleted my entire HOME directory. 

These methods are actually from `path`. But in Node v0.8 they are moved from `path` to `fs`. So you might as well start future proofing your code now.

[1]: http://nodejs.org/docs/latest/api/fs.html 

		@@ -0,1 +1,5 @@
		0.1.1 / 2012-06-15
		==================
		* Fixed bug in `remove()`/`delete()` that wouldn't execute the function if a callback wasn't passed.

		0.1.0 / 2012-05-31
		@@ -2,0 +6,0 @@ ==================

		@@ -0,1 +1,2 @@
		// Generated by CoffeeScript 1.3.3
		(function() {
		@@ -2,0 +3,0 @@ var BUF_LENGTH, copy, copyFile, copyFileSync, fs, ncp, _buff;

		@@ -0,1 +1,2 @@
		// Generated by CoffeeScript 1.3.3
		(function() {
		@@ -12,3 +13,5 @@ var copy, fs, fse, key, mkdir, path, remove, val;
		val = fs[key];
		if (typeof val === 'function') fse[key] = val;
		if (typeof val === 'function') {
		fse[key] = val;
		}
		}
		@@ -38,5 +41,9 @@

		if (!(fs.exists != null)) fs.exists = path.exists;
		if (!(fs.exists != null)) {
		fs.exists = path.exists;
		}

		if (!(fs.existsSync != null)) fs.existsSync = path.existsSync;
		if (!(fs.existsSync != null)) {
		fs.existsSync = path.existsSync;
		}

		@@ -43,0 +50,0 @@ module.exports = fs;

		@@ -0,1 +1,2 @@
		// Generated by CoffeeScript 1.3.3
		(function() {
		@@ -2,0 +3,0 @@ var mkdirp;

+@@ -0,1 +1,2 @@
+// Generated by CoffeeScript 1.3.3
+(function() {
+@@ -13,3 +14,7 @@ var fs, rimraf, rmrf, rmrfSync;
+  rmrf = function(dir, cb) {
+    return rimraf(dir, cb);
+    if (cb != null) {
+      return rimraf(dir, cb);
+    } else {
+      return rimraf(dir, (function() {}));
+  };
+@@ -26,2 +31,3 @@
+  module.exports.rmrfSync = rmrfSync;
+@@ -28,0 +34,0 @@

		{
		"name" : "fs-extra",
		"version" : "0.1.0",
		"version" : "0.1.1",
		"description" : "fs-extra contains methods that aren't included in the vanilla Node.js fs package.",
		@@ -5,0 +5,0 @@ "homepage" : [

		@@ -129,4 +129,9 @@ Node.js: fs-extra
		});
		```

		### exists() / existsSync()

		These methods are actually from `path`. But in Node v0.8 they are moved from `path` to `fs`. So you might as well start future proofing your code now.


		## License
		@@ -133,0 +138,0 @@

Improved metrics