fs-extra vs memfs vs memory-fs vs mock-fs
Node.js 檔案系統相關套件
fs-extramemfsmemory-fsmock-fs類似套件:

Node.js 檔案系統相關套件

這些套件提供了不同的檔案系統操作功能,適用於不同的使用場景。它們可以幫助開發者在 Node.js 環境中進行檔案的讀取、寫入、模擬等操作,並且各自有其特定的用途和設計理念。

npm下載趨勢

3 年

GitHub Stars 排名

統計詳情

套件
下載數
Stars
大小
Issues
發布時間
許可
fs-extra307,458,6929,59659.9 kB202 個月前MIT
memfs53,111,1112,11073.7 kB547 天前Apache-2.0
memory-fs9,496,904876-307 年前MIT
mock-fs1,291,518919107 kB752 年前MIT

功能比較: fs-extra vs memfs vs memory-fs vs mock-fs

檔案操作功能

  • fs-extra:

    fs-extra 擴展了 Node.js 的 fs 模組,提供了額外的檔案操作功能,例如簡單的複製、移動、刪除和創建目錄等,並且支持遞迴操作。

  • memfs:

    memfs 提供了一個完整的檔案系統 API,讓開發者可以在記憶體中創建、讀取和刪除檔案,適合需要快速操作的場景。

  • memory-fs:

    memory-fs 提供了簡單的檔案讀寫接口,特別設計用於與 Webpack 等工具搭配使用,能有效地在記憶體中處理檔案。

  • mock-fs:

    mock-fs 允許開發者在測試中創建虛擬的檔案系統,能夠模擬檔案的存在與內容,方便進行單元測試。

使用場景

  • fs-extra:

    適合用於需要處理大量檔案操作的應用程式,例如檔案上傳、備份和資料夾管理等。

  • memfs:

    非常適合用於測試環境,開發者可以在不影響實際檔案系統的情況下進行測試。

  • memory-fs:

    常用於 Webpack 的插件開發中,能夠在編譯過程中快速讀寫檔案。

  • mock-fs:

    適合用於單元測試,特別是在需要模擬檔案系統行為的情況下。

設計原則

  • fs-extra:

    設計上旨在簡化檔案操作,提供一致的 API 來處理常見的檔案系統任務。

  • memfs:

    專注於在記憶體中模擬檔案系統,強調性能和效率,適合快速開發和測試。

  • memory-fs:

    設計上輕量且高效,專為需要快速檔案操作的場景而設計。

  • mock-fs:

    強調靈活性和可配置性,允許開發者根據需要定義檔案系統的結構和行為。

一致性

  • fs-extra:

    提供與 Node.js 原生 fs 模組一致的操作方式,讓開發者無需學習新的 API。

  • memfs:

    在記憶體中模擬檔案系統,保持與原生檔案系統操作的一致性。

  • memory-fs:

    提供與 Node.js fs 模組相似的 API,易於上手和使用。

  • mock-fs:

    模擬檔案系統的行為,保持與實際檔案系統操作的一致性,便於測試。

可擴展性

  • fs-extra:

    可與其他 Node.js 模組結合使用,提供擴展的檔案操作功能。

  • memfs:

    設計上可擴展,開發者可以根據需求自定義檔案系統的行為。

  • memory-fs:

    可與其他工具集成,支持多種擴展功能。

  • mock-fs:

    提供靈活的 API 來定義虛擬檔案系統,便於擴展和自定義。

如何選擇: fs-extra vs memfs vs memory-fs vs mock-fs

  • fs-extra:

    如果你需要擴展 Node.js 的內建 fs 模組,並且希望使用更簡單的 API 來處理檔案和目錄的操作,fs-extra 是一個理想的選擇。它提供了許多額外的功能,例如遞迴複製和刪除等。

  • memfs:

    選擇 memfs 如果你需要在記憶體中模擬檔案系統,特別是在測試環境中。它允許你在不實際寫入磁碟的情況下進行檔案操作,非常適合單元測試和快照測試。

  • memory-fs:

    memory-fs 是一個輕量級的記憶體檔案系統,適合用於 Webpack 等工具中,當你需要在記憶體中處理檔案時,它能提供高效的檔案讀寫操作。

  • mock-fs:

    如果你需要在測試中模擬檔案系統的行為,mock-fs 是一個不錯的選擇。它允許你定義虛擬檔案和目錄結構,並在測試中使用,避免對實際檔案系統的依賴。

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