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

const copySync = require('../copy').copySync

const removeSync = require('../remove').removeSync

const mkdirpSync = require('../mkdirs').mkdirpSync

  const overwrite = opts.overwrite || opts.clobber || false

  const { srcStat, isChangingCase = false } = stat.checkPathsSync(src, dest, 'move', opts)

  stat.checkParentPathsSync(src, srcStat, dest, 'move')

  if (!isParentRoot(dest)) mkdirpSync(path.dirname(dest))

  return doRename(src, dest, overwrite, isChangingCase)

function doRename (src, dest, overwrite, isChangingCase) {

  if (isChangingCase) return rename(src, dest, overwrite)

  if (fs.existsSync(dest)) throw new Error('dest already exists.')

    return moveAcrossDevice(src, dest, overwrite)

function moveAcrossDevice (src, dest, overwrite) {

const remove = require('../remove').remove

const mkdirp = require('../mkdirs').mkdirp

const pathExists = require('../path-exists').pathExists

  stat.checkPaths(src, dest, 'move', opts, (err, stats) => {

    const { srcStat, isChangingCase = false } = stats

    stat.checkParentPaths(src, srcStat, dest, 'move', err => {

      if (isParentRoot(dest)) return doRename(src, dest, overwrite, isChangingCase, cb)

      mkdirp(path.dirname(dest), err => {

        return doRename(src, dest, overwrite, isChangingCase, cb)

function doRename (src, dest, overwrite, isChangingCase, cb) {

  if (isChangingCase) return rename(src, dest, overwrite, cb)

      return rename(src, dest, overwrite, cb)

  pathExists(dest, (err, destExists) => {

    if (destExists) return cb(new Error('dest already exists.'))

    return rename(src, dest, overwrite, cb)

function rename (src, dest, overwrite, cb) {

    if (err.code !== 'EXDEV') return cb(err)

    return moveAcrossDevice(src, dest, overwrite, cb)

function moveAcrossDevice (src, dest, overwrite, cb) {

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

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

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

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

    "test-find": "find ./lib/**/__tests__ -name *.test.js | xargs mocha",

    "test": "npm run lint && npm run unit && npm run unit-esm",

`fs-extra` adds file system methods that aren't included in the native `fs` module and adds promise support to the `fs` methods. It also uses [`graceful-fs`](https://github.com/isaacs/node-graceful-fs) to prevent `EMFILE` errors. It should be a drop in replacement for `fs`.

[![npm Package](https://img.shields.io/npm/v/fs-extra.svg)](https://www.npmjs.org/package/fs-extra)

[![License](https://img.shields.io/npm/l/fs-extra.svg)](https://github.com/jprichardson/node-fs-extra/blob/master/LICENSE)

[![build status](https://img.shields.io/github/workflow/status/jprichardson/node-fs-extra/Node.js%20CI/master)](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)

[![build status](https://img.shields.io/github/actions/workflow/status/jprichardson/node-fs-extra/ci.yml?branch=master)](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)

[![downloads per month](http://img.shields.io/npm/dm/fs-extra.svg)](https://www.npmjs.org/package/fs-extra)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

I got tired of including `mkdirp`, `rimraf`, and `ncp` in most of my projects.

`fs-extra` is a drop in replacement for native `fs`. All methods in `fs` are attached to `fs-extra`. All `fs` methods return promises if the callback isn't passed.

You don't ever need to include the original `fs` module again:

const fs = require('fs') // this is no longer necessary

or if you prefer to make it clear that you're using `fs-extra` and not `fs`, you may want

to name your `fs` variable `fse` like so:

you can also keep both, but it's redundant:

There is also an `fs-extra/esm` import, that supports both default and named exports. However, note that `fs` methods are not included in `fs-extra/esm`; you still need to import `fs` and/or `fs/promises` seperately:

import { outputFile, outputFileSync } from 'fs-extra/esm'

// fse.readFileSync is not a function; must use fs.readFileSync

but you probably want to just use regular `fs-extra` instead of `fs-extra/esm` for default exports:

// both fs and fs-extra methods are defined

Most methods are async by default. All async methods will return a promise if the callback isn't passed.

Sync methods on the other hand will throw if an error occurs.

Also Async/Await will throw an error if one occurs.

fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {

When running unit tests, set the environment variable `CROSS_DEVICE_PATH` to the absolute path of an empty directory on another device (like a thumb drive) to enable cross-device move tests.

If you run the tests on the Windows and receive a lot of symbolic link `EPERM` permission errors, it's

because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's

account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7

However, I didn't have much luck doing this.

Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows.

I open the `Node.js command prompt` and run as `Administrator`. I then map the network drive running the following command:

    net use z: "\\vmware-host\Shared Folders"

I can then navigate to my `fs-extra` directory and run the tests.

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:

* 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 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)`. 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:

- [Isaac Shlueter](https://github.com/isaacs)

- [Charlie McConnel](https://github.com/avianflu)

- [James Halliday](https://github.com/substack)

- [Andrew Kelley](https://github.com/andrewrk)

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

[jsonfile]: https://github.com/jprichardson/node-jsonfile

		@@ -48,3 +48,4 @@ 'use strict'
		overwrite,
		errorOnExist: true
		errorOnExist: true,
		preserveTimestamps: true
		}
		@@ -51,0 +52,0 @@ copySync(src, dest, opts)

		@@ -67,3 +67,4 @@ 'use strict'
		overwrite,
		errorOnExist: true
		errorOnExist: true,
		preserveTimestamps: true
		}
		@@ -70,0 +71,0 @@ copy(src, dest, opts, err => {

		{
		"name": "fs-extra",
		"version": "11.1.0",
		"version": "11.1.1",
		"description": "fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as recursive mkdir, copy, and remove.",
		@@ -5,0 +5,0 @@ "engines": {

		@@ -8,3 +8,3 @@ Node.js: fs-extra
		[![License](https://img.shields.io/npm/l/fs-extra.svg)](https://github.com/jprichardson/node-fs-extra/blob/master/LICENSE)
		[![build status](https://img.shields.io/github/workflow/status/jprichardson/node-fs-extra/Node.js%20CI/master)](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)
		[![build status](https://img.shields.io/github/actions/workflow/status/jprichardson/node-fs-extra/ci.yml?branch=master)](https://github.com/jprichardson/node-fs-extra/actions/workflows/ci.yml?query=branch%3Amaster)
		[![downloads per month](http://img.shields.io/npm/dm/fs-extra.svg)](https://www.npmjs.org/package/fs-extra)
		@@ -231,3 +231,5 @@ [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

		When running unit tests, set the environment variable `CROSS_DEVICE_PATH` to the absolute path of an empty directory on another device (like a thumb drive) to enable cross-device move tests.


		### Windows
		@@ -234,0 +236,0 @@

Improved metrics