fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir
File Copying and Deletion Libraries Comparison
1 Year
fs-extrarimrafncpcopyfilescpxcopy-dirSimilar Packages:
What's File Copying and Deletion Libraries?

These libraries provide various functionalities for copying and deleting files and directories in Node.js applications. They simplify the process of file management, allowing developers to efficiently handle file operations such as copying, moving, and deleting files and directories with different levels of customization and performance optimization. Each package has its own strengths and use cases, catering to different needs in file manipulation tasks.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
fs-extra109,443,7879,52055.3 kB15a month agoMIT
rimraf97,677,4355,715281 kB137 months agoISC
ncp3,659,691683-8110 years agoMIT
copyfiles1,302,807414-554 years agoMIT
cpx264,703527-358 years agoMIT
copy-dir90,010---5 years agoMIT
Feature Comparison: fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir

Ease of Use

  • fs-extra:

    fs-extra extends the native fs module, making it easy to use familiar methods while adding additional functionality, which makes it intuitive for developers already accustomed to Node.js file operations.

  • rimraf:

    rimraf provides a simple command to remove files and directories recursively, making it easy to use and integrate into scripts for cleanup tasks.

  • ncp:

    ncp has a straightforward API that allows for easy copying of files and directories, making it accessible for developers looking for a quick solution without complex configurations.

  • copyfiles:

    copyfiles provides a command-line interface that allows for easy integration into scripts, enabling complex file copying with glob patterns, making it user-friendly for developers familiar with shell commands.

  • cpx:

    cpx is designed for simplicity, allowing you to copy files and directories with a single command, making it a great choice for quick setups and build processes.

  • copy-dir:

    copy-dir offers a simple API that allows you to copy entire directories with minimal configuration, making it ideal for quick tasks without much overhead.

Performance

  • fs-extra:

    fs-extra is built with performance in mind, providing efficient methods for file operations that can handle large files and directories without significant overhead.

  • rimraf:

    rimraf is highly efficient for deleting files and directories, ensuring that all files are removed quickly, even in deep directory structures.

  • ncp:

    ncp is known for its speed and efficiency in copying files and directories, making it a preferred choice for performance-sensitive applications.

  • copyfiles:

    copyfiles is designed to handle multiple file patterns efficiently, making it suitable for projects with complex file structures and large numbers of files.

  • cpx:

    cpx is lightweight and performs well for copying files in build processes, especially when used in conjunction with watch tasks.

  • copy-dir:

    copy-dir is optimized for copying directories efficiently, but may not handle large files as quickly as some alternatives due to its simplicity.

Advanced Features

  • fs-extra:

    fs-extra includes additional features such as JSON file manipulation and recursive directory creation, making it a versatile choice for various file operations.

  • rimraf:

    rimraf is primarily focused on deletion and does not offer advanced features like file filtering or progress tracking, but excels in its core functionality.

  • ncp:

    ncp provides a simple API but lacks advanced features like progress tracking or file filtering, focusing instead on efficient copying.

  • copyfiles:

    copyfiles supports glob patterns and can copy files based on complex matching rules, providing flexibility for developers who need to specify file selections.

  • cpx:

    cpx allows for watching files and directories for changes, making it useful for live development scenarios where files need to be copied automatically upon changes.

  • copy-dir:

    copy-dir focuses on basic directory copying without many advanced features, making it suitable for straightforward tasks.

Community and Maintenance

  • fs-extra:

    fs-extra is widely used and well-maintained, with a large community backing it, ensuring that it remains a stable choice for file operations.

  • rimraf:

    rimraf is a popular choice for file deletion and is well-maintained, with a strong community ensuring its reliability and updates.

  • ncp:

    ncp has a decent community and is maintained, but it may not be as actively developed as some other options, which could impact long-term support.

  • copyfiles:

    copyfiles has a growing community and is actively maintained, ensuring that it stays up-to-date with the latest Node.js features and practices.

  • cpx:

    cpx is maintained by a smaller group, but it is reliable for its intended use cases, especially in build processes.

  • copy-dir:

    copy-dir has a smaller community and may not receive frequent updates, but it serves its purpose well for basic copying tasks.

Error Handling

  • fs-extra:

    fs-extra includes robust error handling, providing detailed error messages and handling edge cases effectively during file operations.

  • rimraf:

    rimraf has straightforward error handling, focusing on ensuring that files are deleted without leaving remnants, but may not provide detailed feedback on errors.

  • ncp:

    ncp provides basic error handling but may not offer detailed logs, which can make debugging issues more challenging.

  • copyfiles:

    copyfiles includes error handling for file operations, providing feedback on which files failed to copy, making it easier to debug issues.

  • cpx:

    cpx offers basic error handling, but may not provide extensive logging or feedback on errors encountered during file copying.

  • copy-dir:

    copy-dir provides basic error handling, but may not offer detailed feedback on issues encountered during copying.

How to Choose: fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir
  • fs-extra:

    Use fs-extra for a comprehensive file system utility that extends the native fs module, providing additional methods for file manipulation, including copying and removing files with ease and additional features like JSON file handling.

  • rimraf:

    Select rimraf for a robust solution for recursively removing files and directories, especially when dealing with deep directory structures or when you need to ensure that all files are deleted without leaving any traces.

  • ncp:

    Choose ncp for a straightforward and efficient way to copy files and directories, especially if you need a simple API and are working with Node.js environments where performance is a concern.

  • copyfiles:

    Select copyfiles if you require a flexible and powerful tool to copy files with support for glob patterns, allowing you to specify complex file selections easily.

  • cpx:

    Opt for cpx if you need a simple command-line tool for copying files and directories, especially for use in build processes or scripts with a focus on ease of use and minimal setup.

  • copy-dir:

    Choose copy-dir if you need a straightforward solution for copying directories recursively with minimal configuration and a focus on simplicity.

README for fs-extra

Node.js: fs-extra

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 to prevent EMFILE errors. It should be a drop in replacement for fs.

npm Package License build status downloads per month JavaScript Style Guide

Why?

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

Installation

npm install fs-extra

Usage

CommonJS

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

you can now do this:

const fs = require('fs-extra')

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:

const fse = require('fs-extra')

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

const fs = require('fs')
const fse = require('fs-extra')

ESM

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 { readFileSync } from 'fs'
import { readFile } from 'fs/promises'
import { outputFile, outputFileSync } from 'fs-extra/esm'

Default exports are supported:

import fs from 'fs'
import fse 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:

import fs from 'fs-extra'
// both fs and fs-extra methods are defined

Sync vs Async vs Async/Await

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.

Example:

const fs = require('fs-extra')

// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
  .then(() => console.log('success!'))
  .catch(err => console.error(err))

// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// Sync:
try {
  fs.copySync('/tmp/myfile', '/tmp/mynewfile')
  console.log('success!')
} catch (err) {
  console.error(err)
}

// Async/Await:
async function copyFiles () {
  try {
    await fs.copy('/tmp/myfile', '/tmp/mynewfile')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

copyFiles()

Methods

Async

Sync

NOTE: You can still use the native Node.js methods. They are promisified and copied over to fs-extra. See notes on fs.read(), fs.write(), & fs.writev()

What happened to walk() and walkSync()?

They were removed from fs-extra in v2.0.0. If you need the functionality, walk and walkSync are available as separate packages, klaw and klaw-sync.

Third Party

CLI

fse-cli allows you to run fs-extra from a console or from npm scripts.

TypeScript

If you like TypeScript, you can use fs-extra with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra

File / Directory Watching

If you want to watch for changes to files or directories, then you should use chokidar.

Obtain Filesystem (Devices, Partitions) Information

fs-filesystem allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.

Misc.

Hacking on fs-extra

Wanna hack on fs-extra? Great! Your help is needed! fs-extra is one of the most depended upon Node.js packages. This project uses JavaScript Standard Style - if the name or style choices bother you, you're gonna have to get over it :) If standard is good enough for npm, it's good enough for fs-extra.

js-standard-style

What's needed?

  • First, take a look at existing issues. Those are probably going to be where the priority lies.
  • More tests for edge cases. Specifically on different platforms. There can never be enough tests.
  • Improve test coverage.

Note: If you make any big changes, you should definitely file an issue for discussion first.

Running the Test Suite

fs-extra contains hundreds of tests.

  • npm run lint: runs the linter (standard)
  • npm run unit: runs the unit tests
  • npm run unit-esm: runs tests for fs-extra/esm exports
  • npm test: runs the linter and all tests

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

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.

Naming

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

Credit

fs-extra wouldn't be possible without using the modules from the following authors:

License

Licensed under MIT

Copyright (c) 2011-2024 JP Richardson