fs-extra vs ncp vs copyfiles vs cpx vs copy-dir
檔案複製工具
fs-extrancpcopyfilescpxcopy-dir類似套件:

檔案複製工具

這些 npm 套件提供了不同的檔案複製功能,適用於各種開發場景。它們可以幫助開發者輕鬆地將檔案和資料夾從一個位置複製到另一個位置,並提供了不同的選項和功能,以滿足不同的需求。這些工具的使用可以提高開發效率,簡化檔案管理的過程。

npm下載趨勢

3 年

GitHub Stars 排名

統計詳情

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

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

功能簡介

  • fs-extra:

    fs-extra 擴展了 Node.js 的內建 fs 模組,提供了更多的檔案操作功能,如檔案的移動、刪除和創建資料夾等,功能非常全面。

  • ncp:

    ncp 提供了一個簡單的方式來複製資料夾及其內容,支持遞迴複製,並且對於大多數基本需求來說,使用起來非常方便。

  • copyfiles:

    copyfiles 支持使用 glob 模式來選擇要複製的檔案,並且可以指定目標資料夾,非常適合需要複製特定檔案的情況。

  • cpx:

    cpx 提供了即時監視檔案變更的功能,當檔案發生變化時自動複製,特別適合開發過程中的即時更新需求。

  • copy-dir:

    copy-dir 提供了一個簡單的 API 來複製整個資料夾,支持遞迴複製,並且可以選擇是否覆蓋已存在的檔案。

使用場景

  • fs-extra:

    適合需要進行多種檔案系統操作的情況,特別是當需要進行複雜的檔案管理時。

  • ncp:

    適合快速複製資料夾及其內容,特別是在簡單的項目中。

  • copyfiles:

    非常適合需要根據特定模式複製檔案的情況,例如在構建過程中選擇特定的資源檔案。

  • cpx:

    適合用於開發過程中,當需要即時更新檔案時,特別是在使用熱重載的情況下。

  • copy-dir:

    適合用於簡單的檔案複製需求,特別是在不需要複雜選項的情況下。

設計原則

  • fs-extra:

    設計全面,擴展了 Node.js 的原生功能,提供更多的檔案操作選項。

  • ncp:

    設計簡單,專注於基本的複製需求,使用方便。

  • copyfiles:

    設計靈活,支持使用 glob 模式來選擇檔案,適合多樣化需求。

  • cpx:

    設計以開發者為中心,提供即時監視功能,提升開發效率。

  • copy-dir:

    設計簡單明瞭,專注於資料夾的複製,使用方便。

維護性

  • fs-extra:

    由於功能全面,維護性較高,但可能需要更多的測試來確保所有功能正常運行。

  • ncp:

    維護性高,因為其功能簡單且使用方便。

  • copyfiles:

    維護性良好,因為其功能相對簡單且專注於特定需求。

  • cpx:

    由於功能較為專一,維護性較高,但需要注意監視功能的性能。

  • copy-dir:

    由於功能簡單,維護性較高,容易理解和使用。

學習曲線

  • fs-extra:

    學習曲線稍微陡峭,因為功能較多,但對於有經驗的開發者來說,使用起來會很方便。

  • ncp:

    學習曲線平緩,適合所有級別的開發者使用。

  • copyfiles:

    學習曲線相對簡單,特別是對於熟悉 glob 模式的開發者。

  • cpx:

    學習曲線較平緩,特別是對於需要即時更新的開發者。

  • copy-dir:

    學習曲線平緩,適合新手快速上手。

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

  • fs-extra:

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

  • 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