fs-extra、memfs、memory-fs、mock-fs は、Node.js 環境でのファイル操作を扱うためのパッケージですが、それぞれ目的と動作環境が異なります。fs-extra は標準の fs モジュールを拡張し、本番環境でのファイル操作を容易にするためのユーティリティです。一方、memfs と memory-fs はディスクへの書き込みを行わないインメモリファイルシステムを実装しており、主にバンドラーや高速なテスト環境で利用されます。mock-fs は、テスト実行時に実際のファイルシステムアクセスをモック(偽装)することに特化しています。これらを正しく使い分けることで、ディスク I/O のオーバーヘッドを避けたり、ファイル操作のテストを安定させたりできます。
Node.js でファイル操作を行う際、標準の fs モジュールだけでは不十分な場面や、テスト環境でディスクアクセスを避けたい場面がよくあります。fs-extra、memfs、memory-fs、mock-fs はそれぞれ異なるアプローチでこの課題を解決しますが、内部構造と適したユースケースは大きく異なります。本稿では、これら 4 つのパッケージの技術的な違いと、実際のコードでどのように振る舞うかを比較します。
これらパッケージの最大の違いは、ファイルがどこに保存されるかです。
fs-extra は実際のディスクに書き込みます。
fs モジュールのラッパーです。// fs-extra: 実際のディスクにファイルを作成
const fs = require('fs-extra');
async function createFile() {
await fs.outputFile('/tmp/test.txt', 'hello');
// 実際の /tmp ディレクトリにファイルが生成されます
}
memfs はメモリ上に仮想ファイルシステムを作ります。
Volume オブジェクトを通じて操作します。// memfs: メモリ上に仮想ボリュームを作成
const { Volume } = require('memfs');
const vol = new Volume();
vol.writeFileSync('/test.txt', 'hello');
// 実際のディスクには何も書き込まれません
memory-fs もインメモリファイルシステムですが、レガシーな実装です。
memfs と同様にメモリ上で動作します。// memory-fs: 古いインメモリ実装
const MemoryFileSystem = require('memory-fs');
const fs = new MemoryFileSystem();
fs.writeFileSync('/test.txt', 'hello');
// memfs と同様にメモリ内でのみ完結します
mock-fs は標準 fs モジュールの呼び出しをインターセプト(横取り)します。
// mock-fs: fs モジュールの呼び出しを偽装
const mock = require('mock-fs');
mock({
'/fake/dir': {
'test.txt': 'hello'
}
});
// 以降の fs.readFile などはモックされたデータを返します
実務では、ファイルの書き込みやディレクトリの確保がよく行われます。各パッケージがどのようにこれらを処理するか見てみましょう。
fs-extra は存在しないディレクトリも自動で作成できます。
outputFile や ensureDir といった便利なメソッドが用意されています。// fs-extra: 存在しないパスも自動作成
const fs = require('fs-extra');
async function saveConfig() {
// /config/app/ がなくても自動で作成され、ファイルが書かれます
await fs.outputFile('/config/app/settings.json', '{"theme": "dark"}');
}
memfs は JSON 構造からファイルシステム全体を一度に構築できます。
fromJSON メソッドを使えば、テスト用のファイル構造を瞬時に定義可能です。// memfs: JSON からファイルシステムを構築
const { Volume } = require('memfs');
const vol = Volume.fromJSON({
'/config/app/settings.json': '{"theme": "dark"}',
'/logs/app.log': ''
});
// 一瞬で指定された構造のメモリファイルシステムが完成します
memory-fs は標準の fs メソッドに準拠していますが、機能は限定的です。
mkdirp 的な機能は自分で実装するか、追加のロジックが必要です。// memory-fs: 手動でディレクトリを作成する必要がある場合も
const MemoryFileSystem = require('memory-fs');
const fs = new MemoryFileSystem();
fs.mkdirpSync('/config/app');
fs.writeFileSync('/config/app/settings.json', '{"theme": "dark"}');
mock-fs はテスト開始時にファイル構造を定義します。
// mock-fs: モック環境での書き込み
const mock = require('mock-fs');
const fs = require('fs');
mock();
fs.writeFileSync('/settings.json', '{"theme": "dark"}');
// モックされた環境内にファイルが作成されます
テスト環境では、あるテストが別のテストに影響を与えないよう、環境の孤立性が重要です。
fs-extra は実際のディスクを操作するため、後片付けが必要です。
afterEach などで生成したファイルを削除する処理を明示的に書く必要があります。// fs-extra: 手動でクリーンアップが必要
test('should create file', async () => {
await fs.outputFile('/tmp/test.txt', 'data');
// ... 検証 ...
await fs.remove('/tmp/test.txt'); // 必ず削除する
});
memfs はボリュームごとに完全に独立しています。
Volume インスタンスを作れば、完全に孤立した環境になります。// memfs: インスタンスごとに独立した環境
test('should create file', () => {
const vol = new Volume();
vol.writeFileSync('/test.txt', 'data');
// テスト終了後、vol 変数が消えればデータも消滅します
});
memory-fs もインスタンスベースで孤立性を保てます。
memfs に似ていますが、API の古さが懸念点です。memfs への移行コストが発生する可能性があります。// memory-fs: インスタンスごとの孤立性
const fs = new MemoryFileSystem();
fs.writeFileSync('/test.txt', 'data');
// インスタンスが破棄されればデータも消えます
mock-fs はグローバルな fs モジュールを置き換えます。
mock.restore() を呼び忘れると、他のテストに影響が出る危険性があります。// mock-fs: 明示的なリストアが必要
test('should read file', () => {
mock({ '/file.txt': 'content' });
// ... 検証 ...
mock.restore(); // 忘れずに元に戻す
});
パッケージの長期的な安定性は、アーキテクチャ選定において重要な要素です。
fs-extra は非常に安定しており、事実上の標準です。
// fs-extra: 長期的なサポートが期待できる
// 多くの企業プロジェクトで採用されている実績があります
const fs = require('fs-extra');
memfs は現在、インメモリ FS のデファクトスタンダードになりつつあります。
memory-fs の後継として位置づけられることが多いです。// memfs: 現代的なインメモリ実装
// 新規プロジェクトでインメモリ FS が必要な場合の第一選択肢
const { Volume } = require('memfs');
memory-fs は事実上のメンテナンス終了状態に近いです。
// memory-fs: 使用を避けるべきレガシーパッケージ
// 既存プロジェクトからの移行を推奨します
const MemoryFileSystem = require('memory-fs');
mock-fs はテスト用途に特化しており、安定しています。
memfs ほど多機能ではありませんが、目的には合致しています。// mock-fs: テスト用に安定して利用可能
// 単純なファイル読み書きのモックに最適
const mock = require('mock-fs');
| 特徴 | fs-extra | memfs | memory-fs | mock-fs |
|---|---|---|---|---|
| 動作場所 | 実ディスク | メモリ | メモリ | モック(メモリ) |
| 主な用途 | 本番アプリ | バンドラー・高度なテスト | レガシーツール | シンプルなテスト |
| ディレクトリ作成 | 自動 (ensureDir) | 手動または fromJSON | 手動 | 定義時指定 |
| クリーンアップ | 手動削除が必要 | 不要(インスタンス破棄) | 不要(インスタンス破棄) | restore() 必要 |
| メンテナンス | 活発 | 活発 | 停滞気味 | 安定 |
| 推奨度 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐ | ⭐⭐⭐⭐ |
fs-extra は、実際のファイルを保存する必要があるすべての本番アプリケーションで選択すべきです。標準 fs モジュールの不便さを解消し、コードを簡潔に保ちます。
memfs は、インメモリファイルシステムが必要な場合の現代的な選択肢です。特に、バンドラー開発や、ディスク I/O を完全に排除したい高性能テスト環境で真価を発揮します。memory-fs を使っている場合は、こちらへの移行を検討してください。
mock-fs は、ユニットテストでファイル操作をモックしたい場合に最適です。セットアップが簡単で、学習コストが低いため、小規模なテストやプロトタイプに向いています。
memory-fs は、既存のレガシーコードを除き、新規プロジェクトで使用すべきではありません。メンテナンスの観点から、memfs への置き換えが賢明です。
ファイルシステムの選定は、アプリケーションの信頼性とテストのしやすさに直結します。目的に応じて、これらのツールを適切に使い分けてください。
本番環境でファイルの作成、コピー、移動、削除などを行う必要がある場合に選択します。標準の fs モジュールに足りない便利な機能(ensureDir や copy など)が含まれており、ディスクへの永続的な保存が必要な実アプリケーションに適しています。
インメモリファイルシステムが必要な場合に選択します。memory-fs の現代的な代替パッケージであり、より活発にメンテナンスされています。バンドラーの実装や、ディスクアクセスを完全に避けたい高度なテストシナリオで威力を発揮します。
既存のレガシープロジェクトで既に導入されている場合を除き、新規プロジェクトでの使用は推奨されません。memfs によって事実上置き換えられており、メンテナンスの頻度が低いため、長期的な観点では memfs への移行を検討すべきです。
ユニットテストにおいて、実際のディスク操作を行わずにファイルシステムの挙動をシミュレートしたい場合に選択します。セットアップが簡単で、テスト終了後に自動的にクリーンアップされるため、シンプルなテストケースに適しています。
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