fs-extra vs rimraf vs del
檔案刪除與管理
fs-extrarimrafdel類似パッケージ:

檔案刪除與管理

檔案刪除與管理是 Node.js 應用程式中常見的任務,這些任務包括刪除檔案、資料夾以及進行檔案系統操作。這些操作在處理臨時檔案、清理資源或管理應用程式資料時非常重要。這些任務可能涉及同步或非同步操作,並且需要處理錯誤和權限問題。使用專門的函式庫可以簡化這些操作,提高程式碼的可讀性和可靠性。del 是一個專注於刪除檔案和資料夾的輕量級函式庫,特別適合用於清理任務。fs-extra 是對 Node.js 原生 fs 模組的擴展,提供了更多功能,包括刪除、複製和移動檔案。rimraf 是一個用於遞迴刪除資料夾的函式庫,特別適合處理深層資料夾結構,類似於 UNIX 系統中的 rm -rf 命令。

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

3 年

GitHub Starsランキング

統計詳細

パッケージ
ダウンロード数
Stars
サイズ
Issues
公開日時
ライセンス
fs-extra302,592,3909,59459.9 kB211ヶ月前MIT
rimraf213,383,0305,856263 kB91日前BlueOak-1.0.0
del15,519,0211,34533.1 kB01ヶ月前MIT

機能比較: fs-extra vs rimraf vs del

刪除能力

  • fs-extra:

    fs-extra 提供了刪除檔案和資料夾的功能,但它的重點是提供多種檔案系統操作。刪除功能是其中的一部分,但沒有專門針對遞迴刪除進行優化。

  • rimraf:

    rimraf 專門用於遞迴刪除資料夾,確保資料夾及其所有子資料夾和檔案被徹底刪除。它特別適合處理深層資料夾結構,類似於 UNIX 系統中的 rm -rf 命令。

  • del:

    del 支持使用 glob 模式刪除檔案和資料夾,這使得它在清理任務中非常靈活。您可以指定多個路徑,甚至使用通配符來刪除一組檔案。

依賴性

  • fs-extra:

    fs-extra 是一個獨立的函式庫,擴展了原生 fs 模組的功能,沒有額外的外部依賴。

  • rimraf:

    rimraf 是一個輕量級的函式庫,沒有外部依賴,這使得它在刪除操作中非常可靠和高效。

  • del:

    del 依賴於 globby 來處理 glob 模式,這使得它在處理複雜的路徑模式時非常高效。

錯誤處理

  • fs-extra:

    fs-extra 在執行檔案系統操作時提供了錯誤處理,特別是在非同步操作中。它的錯誤處理與原生 fs 模組類似,但提供了更友好的 API。

  • rimraf:

    rimraf 在遞迴刪除過程中處理錯誤,確保即使在遇到權限問題或其他障礙時,仍能盡可能完成刪除操作。

  • del:

    del 提供了良好的錯誤處理機制,特別是在使用非同步操作時。它會在刪除失敗時拋出錯誤,允許開發者進行適當的處理。

範例程式碼

  • fs-extra:

    使用 fs-extra 刪除檔案和資料夾

    const fs = require('fs-extra');
    
    // 刪除單個檔案
    await fs.remove('path/to/file.txt');
    
    // 刪除資料夾及其所有內容
    await fs.remove('path/to/folder');
    
  • rimraf:

    使用 rimraf 遞迴刪除資料夾

    const rimraf = require('rimraf');
    
    // 遞迴刪除資料夾
    rimraf('path/to/folder', (err) => {
      if (err) throw err;
      console.log('資料夾已刪除');
    });
    
  • del:

    使用 del 刪除檔案和資料夾

    const del = require('del');
    
    // 刪除單個檔案
    await del('path/to/file.txt');
    
    // 刪除多個檔案和資料夾
    await del(['path/to/file1.txt', 'path/to/folder']);
    
    // 使用 glob 模式刪除所有 .tmp 檔案
    await del('path/to/**/*.tmp');
    

選び方: fs-extra vs rimraf vs del

  • fs-extra:

    如果您需要一個功能全面的檔案系統操作函式庫,除了刪除外,還包括複製、移動和其他操作,選擇 fs-extra。它是對原生 fs 模組的擴展,提供了更多實用功能,適合需要多種檔案操作的應用程式。

  • rimraf:

    如果您需要一個專門用於遞迴刪除資料夾的工具,特別是在處理深層資料夾結構時,選擇 rimraf。它模擬了 UNIX 系統中的 rm -rf 命令,確保資料夾及其所有內容被安全刪除。

  • del:

    如果您需要一個簡單且高效的工具來刪除檔案和資料夾,特別是在構建流程中清理臨時檔案,選擇 del。它支持 glob 模式,允許您輕鬆指定要刪除的檔案和資料夾。

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