del、fs-extra、rimraf は、Node.js 環境でファイルやディレクトリを削除・管理するための代表的なライブラリです。fs-extra は標準の fs モジュールを拡張し、コピーや移動など包括的な操作を提供します。rimraf は rm -rf のような再帰的削除に特化しており、del はグロブパターンを使用した柔軟なファイル削除に強みを持ちます。それぞれ目的が異なるため、プロジェクトの要件に応じて適切に選択する必要があります。
Node.js でビルドツールの作成やテンポラリーファイルの管理を行う際、ファイルやディレクトリの削除は避けて通れないタスクです。del、fs-extra、rimraf はそれぞれ異なるアプローチでこの問題に解決策を提供しますが、内部の動作原理や適したユースケースには明確な違いがあります。ここでは、実務的な観点からこれら 3 つのライブラリを比較し、最適な選択基準を提示します。
最も基本的な「ディレクトリを丸ごと削除する」操作において、各ライブラリはどのように振る舞うでしょうか。
del はグロブパターンを前提として設計されています。単一のパスを指定することも可能ですが、配列で複数のパターンを渡すのが一般的です。
// del: パターンベースの削除
const del = require('del');
await del(['dist']);
// 配列で複数のパスやパターンを指定可能
await del(['dist', 'tmp/*.log']);
fs-extra は標準 fs モジュールの拡張版です。remove メソッドはファイルかディレクトリかを自動で判別し、再帰的に削除します。
// fs-extra: 統一されたファイルシステム API
const fs = require('fs-extra');
await fs.remove('dist');
// ファイルでもディレクトリでも同じメソッドで処理可能
await fs.remove('temp.log');
rimraf は UNIX コマンド rm -rf の Node.js 実装として有名です。パスを指定すると、存在しない場合でもエラーにならずに処理を終了します(force 動作)。
// rimraf: 再帰的削除に特化
const rimraf = require('rimraf');
await rimraf('dist');
// 存在しないパスを指定してもエラーにならない
await rimraf('non-existent-folder');
複数のファイルをワイルドカードで指定して削除したい場合、ライブラリの選定が重要な分岐点になります。
del はこの用途のために作られています。内部で globby を使用しており、設定なしで直感的にグロブパターンを使えます。
// del: グロブパターンが第一級市民
await del(['src/**/*.test.js']);
// テストファイルのみを削除するなど、細かい制御が容易
fs-extra はグロブパターンをネイティブにはサポートしていません。別途 glob などのライブラリと組み合わせる必要があります。
// fs-extra: 外部ライブラリとの組み合わせが必要
const glob = require('glob');
const fs = require('fs-extra');
const files = await glob('src/**/*.test.js');
await Promise.all(files.map(file => fs.remove(file)));
rimraf も基本的にパス指定です。グロブを使いたい場合は CLI 経由か、事前にパターンを解決するコードが必要です。
// rimraf: 単一パスが基本
await rimraf('dist');
// グロブを使いたい場合は別途 glob モジュールで解決する必要がある
削除操作だけでなく、プロジェクト全体でファイル操作をどう管理するか也是一个重要な視点です。
del は削除に特化しています。コピーや移動機能はありません。依存関係を最小限に抑えたい場合に適しています。
// del: 削除のみ
await del(['build']);
// コピーや移動は別途 fs モジュールなどを使用する必要がある
fs-extra は fs の全機能をカバーし、さらに便利なメソッドを追加しています。コピー、移動、確保(ensureDir)などが統一された API で利用可能です。
// fs-extra: 包括的なファイル操作
await fs.copy('src', 'dist');
await fs.move('old.txt', 'new.txt');
await fs.ensureDir('logs');
rimraf も削除に特化しています。fs-extra のような追加機能はありませんが、削除の堅牢性においては歴史的な信頼があります。
// rimraf: 削除のみ
await rimraf('node_modules/.cache');
// 他の操作は標準 fs を使用する
Node.js 14.14.0 以降、標準の fs モジュールに fs.rm が追加されました。これにより、外部ライブラリの必要性が変化しています。
ネイティブ fs.rm は recursive と force オプションを使うことで、rimraf と同等の動作が可能です。
// Node.js Native: 外部ライブラリ不要
const fs = require('fs').promises;
await fs.rm('dist', { recursive: true, force: true });
// Node 14.14+ で利用可能。依存関係を減らせる
この機能があるため、rimraf を新規プロジェクトで採用する場合は、本当に特別な挙動が必要か検討すべきです。一方、fs-extra の remove は、このネイティブ機能をラップしており、古い Node バージョンとの互換性を気にしなくて良い利点があります。
del に関しては、グロブパターンの解決まで一手に行ってくれるため、ネイティブ機能だけでは代替できません。ビルドスクリプトの簡潔さを求めるなら依然として有力な選択肢です。
// del: グロブ解決込みの削除
await del(['dist/**/*.js']);
// これをネイティブでやるには glob + fs.rm の組み合わせが必要
| 機能 | del | fs-extra | rimraf | Node fs.rm |
|---|---|---|---|---|
| 再帰的削除 | ✅ | ✅ | ✅ | ✅ (v14.14+) |
| グロブパターン | ✅ (ネイティブ) | ❌ (要 glob) | ❌ (要 glob) | ❌ (要 glob) |
| コピー/移動 | ❌ | ✅ | ❌ | ❌ |
| 存在しないパス | 無視して完了 | エラー (場合による) | 無視して完了 | force: true で無視 |
| 主な用途 | ビルド Cleanup | 汎用ファイル操作 | 堅牢な削除 | 依存なし削除 |
実務では、プロジェクトの規模と要件によって最適なツールが異なります。
del は、ビルドパイプラインの一環として「特定のファイル群を掃除する」役割に最適です — 特に Gulp や webpack の後処理などでグロブパターンを活用したい場合に真価を発揮します。コードが簡潔になり、可読性が向上します。
fs-extra は、アプリケーション全体でファイル操作频繁に行われる場合に推奨します。削除だけでなく、ディレクトリ作成やファイルコピーなど、一貫した API で管理できるため、メンテナンス性が向上します。古い Node バージョンをサポートする必要がある場合も安全な選択肢です。
rimraf は、削除操作の堅牢性を最優先する場合に使われます。ただし、Node.js 14.14 以上を前提できるなら、ネイティブの fs.rm で代用することを強く検討してください。依存パッケージを減らすことは、セキュリティリスクの低減とバンドルサイズの最適化につながります。
結論: 削除だけなら fs.rm、グロブ付き削除なら del、ファイル操作全体なら fs-extra。この基準で選定すれば、将来的なメンテナンスコストを最小限に抑えられます。
ファイルの削除だけでなく、コピー、移動、読み書きなど、ファイルシステム操作全体を統一された API で扱いたい場合に選択します。標準 fs モジュールの欠点を補完し、エラー処理や再帰的操作を容易にします。大規模なプロジェクトでファイル操作が多い場合に特に有効です。
深くネストされたディレクトリを確実に削除したい場合に信頼性の高い選択肢です。ただし、Node.js 14.14 以降では標準の fs.rm で同等の機能が可能ため、新規プロジェクトではネイティブ機能との比較検討を推奨します。削除専用ツールとして軽量な依存関係を維持したい場合に適しています。
ビルド後の Cleanup など、特定のパターンに一致する複数のファイルを削除したい場合に最適です。グロブパターンをネイティブにサポートしているため、複雑なファイル指定も簡潔に記述できます。ただし、単一のディレクトリ削除だけならオーバーキルになる可能性があります。
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.
I got tired of including mkdirp, rimraf, and ncp in most of my projects.
npm install fs-extra
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.
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
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()
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()
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.
fse-cli allows you to run fs-extra from a console or from npm scripts.
If you like TypeScript, you can use fs-extra with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fs-extra
If you want to watch for changes to files or directories, then you should use chokidar.
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.
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.
What's needed?
Note: If you make any big changes, you should definitely file an issue for discussion first.
fs-extra contains hundreds of tests.
npm run lint: runs the linter (standard)npm run unit: runs the unit testsnpm run unit-esm: runs tests for fs-extra/esm exportsnpm test: runs the linter and all testsWhen 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:
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).
fs-extra wouldn't be possible without using the modules from the following authors:
Licensed under MIT
Copyright (c) 2011-2024 JP Richardson