fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir
檔案複製與管理工具
fs-extrarimrafncpcopyfilescpxcopy-dir類似套件:

檔案複製與管理工具

這些 npm 套件主要用於檔案的複製、搬移和刪除,提供了不同的功能和使用場景,幫助開發者在 Node.js 環境中更有效地管理檔案系統。這些工具各有其特點,適合不同的需求和使用情境。

npm下載趨勢

3 年

GitHub Stars 排名

統計詳情

套件
下載數
Stars
大小
Issues
發布時間
許可
fs-extra307,458,6929,59659.9 kB202 個月前MIT
rimraf211,577,2785,858263 kB916 天前BlueOak-1.0.0
ncp8,327,754679-7812 年前MIT
copyfiles2,661,336420-566 年前MIT
cpx297,143529-3510 年前MIT
copy-dir197,000---6 年前MIT

功能比較: fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir

功能特性

  • fs-extra:

    fs-extra 是一個功能強大的檔案系統擴展,提供了許多額外的檔案操作功能,如複製、移動、刪除、讀取和寫入等。

  • rimraf:

    rimraf 是一個專門用於遞迴刪除目錄的工具,類似於 UNIX 的 rm -rf 命令,適合處理大型檔案系統的刪除需求。

  • ncp:

    ncp 提供簡單的目錄複製功能,適合快速複製檔案,並且使用簡單,易於上手。

  • copyfiles:

    copyfiles 允許使用 glob 模式選擇檔案,並提供簡單的命令行介面,適合快速複製特定檔案。

  • cpx:

    cpx 支持檔案監視功能,當檔案變更時自動複製,適合開發環境中的即時更新。

  • copy-dir:

    copy-dir 提供簡單的目錄複製功能,支持遞迴複製並保留檔案屬性,適合用於簡單的檔案管理。

使用場景

  • fs-extra:

    適合需要進行複雜檔案操作的情境,如自動化腳本或大型專案的檔案管理。

  • rimraf:

    適合需要清理目錄的情境,如移除臨時檔案或清理專案中的不必要檔案。

  • ncp:

    適合快速複製檔案的情境,如簡單的專案或小型應用的檔案管理。

  • copyfiles:

    適合用於快速複製特定檔案,特別是在構建過程中需要選擇性複製檔案時。

  • cpx:

    適合開發過程中需要即時更新檔案的情境,如前端開發中的資源管理。

  • copy-dir:

    適合用於需要完整複製目錄結構的情境,如備份或部署。

學習曲線

  • fs-extra:

    功能豐富,可能需要一些時間來熟悉各種方法,但文檔詳細,易於學習。

  • rimraf:

    簡單明瞭,易於理解,適合所有級別的開發者。

  • ncp:

    簡單易用,學習曲線平緩,適合快速上手。

  • copyfiles:

    命令行介面簡單易懂,快速上手,適合初學者。

  • cpx:

    需要了解檔案監視的概念,但整體使用簡單,適合有一定經驗的開發者。

  • copy-dir:

    使用簡單,學習曲線平緩,適合新手使用。

性能

  • fs-extra:

    性能穩定,適合各種檔案操作,特別是在處理大檔案時。

  • rimraf:

    性能優越,能夠快速遞迴刪除大型目錄,適合清理操作。

  • ncp:

    性能良好,適合快速複製小型目錄,但在處理大型目錄時可能會稍顯緩慢。

  • copyfiles:

    性能優越,特別是在複製小檔案時,速度快且效率高。

  • cpx:

    性能取決於檔案變更的頻率,適合開發環境中使用。

  • copy-dir:

    在處理大量檔案時性能良好,但可能在複製大檔案時稍顯緩慢。

如何選擇: fs-extra vs rimraf vs ncp vs copyfiles vs cpx vs copy-dir

  • fs-extra:

    選擇 fs-extra 如果你需要一個功能強大的檔案系統擴展,提供了許多額外的檔案操作功能,如複製、移動和刪除等。

  • rimraf:

    選擇 rimraf 如果你需要一個可靠的工具來遞迴刪除目錄,特別是在處理大型檔案系統時。

  • ncp:

    選擇 ncp 如果你需要一個簡單的複製工具,並且不需要過多的配置選項,適合快速複製目錄。

  • copyfiles:

    選擇 copyfiles 如果你需要一個輕量級的解決方案來複製檔案,並且希望能夠使用 glob 模式來選擇檔案。

  • cpx:

    選擇 cpx 如果你需要一個支持監視檔案變更的複製工具,適合用於開發環境中自動化檔案複製。

  • copy-dir:

    選擇 copy-dir 如果你需要一個簡單的工具來遞迴複製目錄,並且希望保留檔案的屬性和權限。

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