fs-extra vs del vs rimraf
File System Cleanup Strategies in Node.js Build Pipelines
fs-extradelrimrafSimilar Packages:

File System Cleanup Strategies in Node.js Build Pipelines

del, fs-extra, and rimraf are essential utilities for managing file system operations in Node.js, specifically focused on deletion and cleanup tasks. rimraf is the low-level engine often used for recursively removing directories, handling cross-platform edge cases like Windows file locking. del builds on top of rimraf to add Promise support and glob pattern matching, making it ideal for build scripts. fs-extra is a comprehensive drop-in replacement for the native fs module that includes removal methods alongside copying, moving, and directory creation tools.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
fs-extra302,592,3909,59459.9 kB21a month agoMIT
del01,34533.1 kB0a month agoMIT
rimraf05,856263 kB9a day agoBlueOak-1.0.0

File System Cleanup Strategies: del vs fs-extra vs rimraf

When managing build artifacts, temporary files, or deployment folders in Node.js, reliable deletion is critical. del, fs-extra, and rimraf all solve this problem but target different layers of the stack. Let's break down how they handle removal, pattern matching, and integration into modern workflows.

šŸ—‘ļø Core Removal Mechanism

All three packages ultimately rely on similar low-level system calls, but they wrap them differently for safety and ease of use.

rimraf is the foundational tool. It focuses purely on removing paths recursively, handling tricky Windows issues like locked files or long path names.

// rimraf: Direct path removal
import rimraf from 'rimraf';

await rimraf('./dist');
// Removes the 'dist' folder and everything inside

del wraps rimraf to add Promise support and glob handling. It delegates the actual deletion work to rimraf but makes the API cleaner for scripts.

// del: Glob-based removal
import del from 'del';

await del(['./dist', './temp']);
// Removes multiple paths using rimraf internally

fs-extra extends the native fs module. Its remove method behaves like rimraf but lives alongside other file utilities like copy and move.

// fs-extra: Extended fs module
import fs from 'fs-extra';

await fs.remove('./dist');
// Removes path, works like rimraf but part of larger toolkit

šŸŽÆ Pattern Matching: Globs vs Paths

One of the biggest differences is how they handle file patterns. Build scripts often need to delete specific file types rather than whole folders.

del supports glob patterns out of the box. You do not need a separate library to find files before deleting them.

// del: Native glob support
import del from 'del';

await del(['dist/**/*.js', 'dist/**/*.map']);
// Finds and deletes all JS and map files in dist

rimraf expects explicit paths. If you need glob support, you must combine it with a library like globby or glob.

// rimraf: Path only (requires extra step for globs)
import rimraf from 'rimraf';
import globby from 'globby';

const files = await globby(['dist/**/*.js']);
await Promise.all(files.map(file => rimraf(file)));
// Manual combination needed for pattern matching

fs-extra also expects explicit paths. It does not interpret glob patterns, keeping the API strict and predictable.

// fs-extra: Path only
import fs from 'fs-extra';
import globby from 'globby';

const files = await globby(['dist/**/*.js']);
await Promise.all(files.map(file => fs.remove(file)));
// Manual combination needed for pattern matching

šŸ”„ API Style: Promises and Modules

Modern Node.js development leans heavily on ES Modules (ESM) and async/await. The packages differ in how they expose these features.

del is ESM-first in recent versions. It returns a Promise by default, fitting naturally into modern async functions.

// del: ESM and Promise native
import del from 'del';

async function clean() {
  await del(['./build']);
}

rimraf supports both ESM and CommonJS depending on the version. Recent versions encourage ESM usage but maintain compatibility.

// rimraf: ESM compatible
import rimraf from 'rimraf';

async function clean() {
  await rimraf('./build');
}

fs-extra works seamlessly with CommonJS and ESM. It mimics the native fs module structure, which helps when migrating legacy code.

// fs-extra: Universal module support
import fs from 'fs-extra';

async function clean() {
  await fs.remove('./build');
}

🧩 Ecosystem Fit: Single Purpose vs Toolkit

Your choice often depends on whether you need just deletion or a full file management suite.

del is single-purpose. It does one thing well — deleting files with patterns. It keeps your dependency tree small if you only need cleanup.

// del: Focused dependency
// Only install if you need glob deletion
import del from 'del';

rimraf is also single-purpose but lower-level. It is often installed as a dependency of other tools rather than directly in your app.

// rimraf: Infrastructure dependency
// Often used inside other build tools
import rimraf from 'rimraf';

fs-extra is a toolkit. If you already use it for copying config files or ensuring directories exist, using it for deletion reduces package count.

// fs-extra: All-in-one toolkit
// Use for copy, move, ensureDir, and remove
import fs from 'fs-extra';

šŸ›”ļø Native Node.js Alternatives

Since Node.js 14.14.0, the native fs module includes fs.rm with recursive support. This changes the calculation for new projects.

del still adds value for globbing. Native fs does not handle patterns, so del saves you from writing extra logic.

// Native fs: No glob support
import fs from 'fs';

// Cannot delete *.js directly without glob library
await fs.rm('./dist', { recursive: true, force: true });

rimraf handles edge cases better than native fs.rm on some Windows setups. It is safer for critical cleanup tasks where failure is not an option.

// Native fs: Basic recursive removal
import fs from 'fs';

await fs.rm('./dist', { recursive: true, force: true });
// Works well but less battle-tested on edge cases

fs-extra abstracts the native call. It might use fs.rm internally but provides a consistent interface across Node versions.

// Native fs via fs-extra: Consistent interface
import fs from 'fs-extra';

await fs.remove('./dist');
// Handles version differences automatically

šŸ“Š Summary Table

Featuredelfs-extrarimraf
Primary GoalGlob-based deletionFull file system toolkitRecursive path removal
Glob Supportāœ… Built-ināŒ Requires external libāŒ Requires external lib
API StylePromise-basedPromise/CallbackPromise/Callback
Module TypeESM (v6+)CJS + ESMESM + CJS
DependenciesLow (wraps rimraf)None (standalone)None (standalone)
Best ForBuild scriptsApp-wide file opsLow-level tools

šŸ’” Final Recommendation

del is the specialist for build pipelines — if you need to wipe out dist/**/*.js with one line, this is your tool. It saves time on glob logic and keeps scripts readable.

fs-extra is the generalist for application code — if you are already copying files or ensuring directories exist, use its remove method to avoid adding another dependency.

rimraf is the engine for tool authors — if you are building a library that needs robust deletion without the overhead of a full file system suite, this is the standard choice.

Final Thought: For new projects on Node 18+, consider native fs.rm for simple folder deletion, but keep del in your toolkit for pattern-based cleanup during builds.

How to Choose: fs-extra vs del vs rimraf

  • fs-extra:

    Choose fs-extra if your project requires a broad set of file system utilities beyond just deletion, such as copying, moving, or ensuring directories exist. It provides a consistent Promise-based API that mirrors the native fs module while adding safety and convenience methods. This is the right choice for applications that need robust file management throughout the codebase.

  • del:

    Choose del when your build script needs to delete multiple files or folders using glob patterns like dist/**/*.js. It simplifies asynchronous cleanup by returning a Promise and handling pattern matching internally without extra dependencies. This package is best suited for task runners like Gulp or standalone build scripts where conciseness matters.

  • rimraf:

    Choose rimraf when you need a dedicated, high-performance tool specifically for removing paths recursively with maximum reliability across operating systems. It is often used internally by other tools and is suitable when you want minimal abstraction over the deletion process. Use this if you prefer handling glob patterns separately or need fine-grained control over removal options.

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

NOTE: The deprecated constants fs.F_OK, fs.R_OK, fs.W_OK, & fs.X_OK are not exported on Node.js v24.0.0+; please use their fs.constants equivalents.

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 separately:

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:

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