fs-extra vs del vs remove vs rimraf
Node.js におけるファイルとディレクトリの削除戦略
fs-extradelremoverimraf類似パッケージ:

Node.js におけるファイルとディレクトリの削除戦略

del、fs-extra、remove、rimraf は、すべて Node.js 環境でファイルやディレクトリを削除するためのツールですが、それぞれ役割と設計思想が異なります。rimraf は rm -rf コマンドの Node 版として最も標準的な再帰的削除ツールです。fs-extra はネイティブの fs モジュールを拡張し、削除機能も含む包括的なファイル操作ライブラリです。del は rimraf をベースにしつつ、グロブパターン(例:*.log)を使った柔軟なファイル指定に特化しています。一方、remove パッケージは歴史的に存在しますが、現在は rimraf や fs-extra に機能が統合されており、新規プロジェクトでの採用は推奨されません。

npmのダウンロードトレンド

3 年

GitHub Starsランキング

統計詳細

パッケージ
ダウンロード数
Stars
サイズ
Issues
公開日時
ライセンス
fs-extra229,712,0299,59059.9 kB1621日前MIT
del01,34433.1 kB05日前MIT
remove011-314年前MIT
rimraf05,855262 kB128ヶ月前BlueOak-1.0.0

Node.js におけるファイル削除ツールの徹底比較:del vs fs-extra vs remove vs rimraf

Node.js でファイルやディレクトリを削除する際、ネイティブの fs.unlink や fs.rmdir だけでは不十分なケースが多々あります。特に、中身が入ったディレクトリを再帰的に削除する場合や、複数のファイルをパターン指定で削除する場合、標準モジュールだけではコードが煩雑になります。

そこで登場するのが del、fs-extra、remove、rimraf といったライブラリです。これらはすべて「削除」という共通の目的を持ちますが、設計思想、機能範囲、そしてメンテナンス状況に大きな違いがあります。本稿では、実務経験に基づき、どの場面でどのツールを選ぶべきかを技術的に深掘りします。

🗑️ 再帰的削除の仕組み:ネイティブ vs ライブラリ

Node.js v14.14.0 以降、ネイティブの fs モジュールにも fs.rm(path, { recursive: true }) が追加されました。しかし、古い Node バージョンをサポートする必要がある場合や、エラーハンドリングを統一したい場合には、ライブラリに頼る価値があります。

rimraf は、この「再帰的削除」に特化したデファクトスタンダードです。UNIX コマンドの rm -rf と同等の動作を Node.js で実現します。

// rimraf: 再帰的削除の標準
const rimraf = require('rimraf');

// ディレクトリごと削除
rimraf('/path/to/dir', () => {
  console.log('deleted');
});

fs-extra は、この rimraf の機能を fs.remove として取り込んでいます。ネイティブの fs モジュールの代わりに使うことで、削除だけでなくコピーや移動も統一された API で扱えます。

// fs-extra: 包括的なファイル操作の一部として削除
const fs = require('fs-extra');

// rimraf と同じく再帰的に削除される
await fs.remove('/path/to/dir');

del は、内部で rimraf を使用していますが、単なる削除ではなく「パターンマッチング」に重点を置いています。

// del: グロブパターンによる削除
const del = require('del');

// 複数のパターンに一致するファイルを削除
await del(['dist/*.js', 'dist/*.map']);

remove パッケージも同様の機能を提供しますが、現在は rimraf ほどの信頼性や更新頻度がありません。

// remove: 歴史的なパッケージ(非推奨)
const remove = require('remove');

// 機能は似ているが、エコシステムとしての支持は低い
remove.dir('/path/to/dir', function(err){ 
  // ...
});

🔍 グロブパターンサポートの有無

ファイル削除において、特定の拡張子を持つファイルだけを対象にしたいケースは頻繁にあります。この際、グロブパターン(*.txt など)を扱えるかが重要な分岐点になります。

del は、最初から globby を内包しており、パターン指定が第一級の機能として提供されています。ビルドツールのクリーンアップタスクなどに最適です。

// del: パターン指定がネイティブサポート
await del(['temp/*.tmp', '!temp/important.tmp']);
// 注意:ignore パターンも使用可能

rimraf、fs-extra、remove は、基本的にパスを直接指定します。グロブパターンを使いたい場合は、別途 glob パッケージなどを組み合わせてパスを解決する必要があります。

// rimraf + glob: 組み合わせが必要
const glob = require('glob');
const rimraf = require('rimraf');

const files = glob.sync('*.log');
files.forEach(file => rimraf.sync(file));

🛡️ 安全性とエラーハンドリング

削除操作は破壊的であるため、エラーハンドリングと安全性が重要です。

fs-extra は、Promise ベースの API が標準で提供されており、async/await との相性が抜群です。また、ネイティブ fs と互換性があるため、既存コードへの導入コストが低いです。

// fs-extra: Promise 対応で扱いやすい
try {
  await fs.remove('/secure/data');
} catch (err) {
  console.error('削除に失敗しました', err);
}

rimraf も Promise をサポートしていますが、バージョンによって API が異なります(v3 以降は Promise 対応)。コールバックスタイルとの互換性も残っています。

// rimraf: Promise スタイル(v3+)
await rimraf('/path/to/dir');

del は、存在しないファイルを削除しようとしてもエラーを出さず、黙って完了する設計になっています。これはクリーンアップスクリプトにおいて、毎回存在チェックを書かなくて済むため非常に便利です。

// del: 存在しないファイルでもエラーにならない
await del(['non-existent-file.txt']); 
// エラーにならず解決される

remove パッケージは、エラーハンドリングの挙動がバージョンや実装によってばらつきがあり、現代的な async/await 環境ではラップが必要になることが多いです。

📦 依存関係とバンドルサイズへの影響

フロントエンドのビルドツール(Webpack や Vite など)を設定する際、依存パッケージの数は重要です。

  • fs-extra を導入すると、それ単体でファイル操作のほとんどが賄えるため、追加のユーティリティが減ります。
  • rimraf は単一機能に特化しているため、軽量ですが、グロブ機能が必要な場合は glob を別途入れる必要があります。
  • del は globby と rimraf を内部に持っているため、これら 2 つを個別にインストールするよりシンプルになる場合があります。
  • remove は、機能面で rimraf に劣るため、依存として追加するメリットがほとんどありません。

🚀 実戦シナリオでの使い分け

シナリオ 1: ビルドディレクトリのクリーンアップ

ビルド前に dist フォルダを空にしたい場合、del が最も適しています。

// 推奨: del
const del = require('del');

async function clean() {
  await del(['dist']);
}

シナリオ 2: 一時ファイルの管理

アプリケーション実行中に生成された一時フォルダを削除する場合、fs-extra または rimraf が適しています。

// 推奨: fs-extra (既に導入している場合)
const fs = require('fs-extra');
await fs.remove('./temp/session_123');

// 推奨: rimraf (軽量さを重視する場合)
const rimraf = require('rimraf');
await rimraf('./temp/session_123');

シナリオ 3: 古いパッケージの移行

もし既存プロジェクトで remove パッケージを使っている場合、それは rimraf への移行を検討すべきタイミングです。

// 非推奨: remove
// const remove = require('remove');

// 推奨: rimraf へ置換
const rimraf = require('rimraf');

📊 機能比較サマリー

機能delfs-extraremoverimraf
再帰的削除✅ (内部で利用)✅ (fs.remove)✅✅
グロブパターン✅ (ネイティブ)❌ (別途必要)❌❌ (別途必要)
Promise 対応✅✅⚠️ (要確認)✅ (v3+)
fs 互換性❌✅ (拡張)❌❌
メンテナンス🟢 活発🟢 活発🔴 停滞気味🟢 活発
主な用途クリーンアップ汎用ファイル操作(非推奨)削除特化

💡 結論:どれを選ぶべきか

現代の Node.js 開発において、remove パッケージを選ぶ理由はほぼありません。機能は rimraf に含まれており、メンテナンス状況も rimraf や fs-extra の方が圧倒的に優れています。

fs-extra は、ファイル操作全般を統一したいプロジェクトにとって最強の選択肢です。既に fs-extra を導入しているなら、追加で rimraf を入れる必要はなく、fs.remove を使うだけで十分です。

rimraf は、余計な機能はいらない、ただ確実に削除したいという場合に最適です。CLI ツールの開発や、内部モジュールとして使用する場合に適しています。

del は、Grunt や Gulp、あるいは npm スクリプトなどで「特定のファイルパターンを削除したい」という明確なニーズがある場合にのみ選択します。グロブパターンの扱いが非常にスムーズです。

最終的には、「汎用性なら fs-extra、削除特化なら rimraf、パターン削除なら del」 という基準で選定するのが、技術的負債を増やさない賢明な判断です。

選び方: fs-extra vs del vs remove vs rimraf

  • fs-extra:

    ファイル削除だけでなく、コピー、移動、JSON 読み書きなど、ファイルシステム操作全般を一元管理したい場合に最適です。fs.remove() メソッドは rimraf と同等の機能を提供し、既存の fs コードを置き換えるだけで導入できます。

  • del:

    ビルドスクリプトなどで、特定のパターンに一致するファイル(例:dist/**/*.js)をまとめて削除したい場合に選択します。グロブパターンサポートが組み込まれているため、設定ファイルの整理やキャッシュクリアに適しています。

  • remove:

    歴史的なパッケージであり、現在はメンテナンスが停滞しているか、機能が rimraf に統合されています。新規プロジェクトでの使用は避け、代わりに rimraf または fs-extra の使用を強く推奨します。

  • rimraf:

    純粋に「ディレクトリを再帰的に削除する」ことだけに特化したツールが必要な場合に選択します。他の依存関係を増やしたくない場合や、ビルドツールの内部ロジックとして軽量な削除機能が必要な時に最適です。

fs-extra のREADME

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