del vs fs-extra vs rimraf
文件和目录删除
搜索包...
delfs-extrarimraf类似的npm包:

文件和目录删除

文件和目录删除库提供了多种方法来删除文件和目录，处理文件系统操作时提供了更高的灵活性和安全性。del 是一个基于 glob 模式的删除库，适合批量删除文件和目录。fs-extra 是对 Node.js 原生 fs 模块的扩展，提供了更多文件操作功能，包括删除。rimraf 是一个专门用于递归删除目录的库，类似于 Unix 的 rm -rf 命令，适合删除深层嵌套的目录。

npm下载趋势

3 年

GitHub Stars 排名

统计详情

npm包名称
下载量
Stars
大小
Issues
发布时间
License
del01,34612.7 kB169 个月前MIT
fs-extra09,61458.1 kB141 个月前MIT
rimraf05,843262 kB94 个月前BlueOak-1.0.0

功能对比: del vs fs-extra vs rimraf

删除方式

  • del:

    del 允许基于 glob 模式删除文件和目录，支持批量删除和排除特定文件。它提供了灵活的删除方式，适合复杂的文件结构。

  • fs-extra:

    fs-extra 提供了多种删除方法，包括删除单个文件、目录和递归删除。它的删除功能是其众多文件操作功能之一，适合需要多功能的文件操作库。

  • rimraf:

    rimraf 专注于递归删除目录，类似于 Unix 的 rm -rf 命令。它在删除深层嵌套目录时表现出色，确保删除操作的彻底性。

异步支持

  • del:

    del 完全支持异步删除，返回一个 Promise，适合现代 JavaScript 异步编程。

  • fs-extra:

    fs-extra 提供同步和异步删除方法，灵活性高，适合不同的编程风格。

  • rimraf:

    rimraf 主要提供异步删除方法，确保删除操作不会阻塞主线程。

依赖性

  • del:

    del 依赖于 globby 进行文件匹配，适合需要复杂文件匹配和删除的场景。

  • fs-extra:

    fs-extra 是一个独立的库，扩展了 Node.js 的 fs 模块，提供了丰富的文件操作功能。

  • rimraf:

    rimraf 是一个轻量级的库，专注于递归删除，没有额外的依赖，适合需要高性能删除的场景。

代码示例

  • del:

    基于 glob 模式删除文件

    const del = require('del');

// 删除所有 .tmp 文件
await del(['**/*.tmp']);

// 删除特定目录，但排除某些文件
await del(['dist/**', '!dist/important.js']);
  • fs-extra:

    使用 fs-extra 删除文件和目录

    const fs = require('fs-extra');

// 删除单个文件
await fs.remove('path/to/file.txt');

// 递归删除目录
await fs.remove('path/to/directory');
  • rimraf:

    递归删除目录

    const rimraf = require('rimraf');

// 删除目录
rimraf('path/to/directory', (err) => {
  if (err) throw err;
  console.log('目录已删除');
});

如何选择: del vs fs-extra vs rimraf

  • del:

    选择 del 如果你需要基于 glob 模式删除文件和目录，特别是在构建工具和任务自动化中。它支持异步操作，适合现代 JavaScript 项目。

  • fs-extra:

    选择 fs-extra 如果你需要一个功能全面的文件系统操作库，除了删除外，还提供复制、移动、创建目录等功能。适合需要多种文件操作的项目。

  • rimraf:

    选择 rimraf 如果你只需要一个简单、高效的递归删除目录的工具，特别是在处理深层嵌套目录时。它是删除目录的标准解决方案，性能优越。

与del类似的npm包

del 是一个用于删除文件和目录的 Node.js 库。它提供了一种简单而强大的方法来清理文件系统，支持删除文件、目录及其内容，并且可以使用 glob 模式来选择要删除的文件。虽然 del 提供了强大的删除功能，但在 Node.js 生态系统中还有其他一些库可以作为替代方案。以下是几个替代库：

  • fs-extra 是一个扩展了 Node.js 原生 fs 模块的库，提供了额外的文件系统方法。它不仅支持文件和目录的删除，还包括复制、移动、读取和写入等功能。fs-extra 旨在提供一个更丰富的 API，使文件操作变得更加简单和直观。如果你需要一个功能全面的文件系统库，fs-extra 是一个不错的选择。
  • rimraf 是一个简单的工具，用于递归删除文件和目录，类似于 UNIX 系统中的 rm -rf 命令。它非常轻量，专注于删除操作，适合需要快速删除大量文件和目录的场景。如果你只需要一个简单的删除工具，而不需要其他文件操作功能，rimraf 是一个理想的选择。

要查看 del 与 fs-extra 和 rimraf 的比较，请访问：比较 del vs fs-extra vs rimraf。

与fs-extra类似的npm包

fs-extra 是一个 Node.js 的文件系统扩展库，提供了许多额外的文件系统方法，使得文件操作更加简单和高效。它在 Node.js 的原生 fs 模块的基础上，增加了许多实用的功能，比如递归创建目录、复制文件和目录、删除文件和目录等。fs-extra 的 API 设计得非常直观，适合需要频繁进行文件操作的开发者。

在 fs-extra 之外，还有一些其他的替代库可以考虑：

  • fs 是 Node.js 的原生文件系统模块，提供了基本的文件操作功能，如读取、写入、删除文件等。虽然 fs 模块功能强大，但在处理一些复杂的文件操作时，可能需要编写更多的代码。对于简单的文件操作，fs 是一个不错的选择，但在需要更高效和简化的操作时，fs-extra 更为合适。
  • fs-extra-promise 是 fs-extra 的一个 Promise 版本，提供了与 fs-extra 相同的功能，但使用 Promise 进行异步操作。这使得在使用 async/await 语法时，处理文件操作变得更加方便。如果你的项目中已经在使用 Promise 或 async/await，fs-extra-promise 是一个理想的选择。

要查看 fs、fs-extra 和 fs-extra-promise 之间的比较，请访问：比较 fs vs fs-extra vs fs-extra-promise。

与rimraf类似的npm包

rimraf 是一个用于删除文件和目录的 Node.js 库，特别是用于递归删除。它是一个非常简单的工具，常用于构建和清理项目中的临时文件和目录。虽然 rimraf 提供了强大的删除功能，但在 Node.js 生态系统中还有其他一些库可以作为替代方案。以下是一些替代库：

  • del 是一个用于删除文件和目录的库，支持使用 glob 模式匹配文件。它提供了更高级的功能，例如可以在删除文件之前进行确认，并且支持 Promise API，使得在异步操作中使用更加方便。如果你需要更灵活的文件删除选项，del 是一个不错的选择。
  • fs-extra 是一个扩展了 Node.js 原生 fs 模块的库，提供了额外的文件系统方法，包括删除文件和目录的功能。fs-extra 的 API 设计与原生 fs 模块相似，因此如果你已经熟悉 fs 模块，使用 fs-extra 会非常自然。它还提供了许多其他有用的文件操作功能，使其成为一个多功能的文件系统库。
  • remove 是一个简单的库，用于删除文件和目录。它的设计目标是提供一个简单易用的 API，适合那些不需要复杂功能的用户。remove 适合小型项目或简单的文件删除需求，确保用户可以快速上手。

要查看 rimraf 与 del、fs-extra 和 remove 的比较，请访问：比较 del vs fs-extra vs remove vs rimraf。

del的README

del

Delete files and directories using globs

Similar to rimraf, but with a Promise API and support for multiple files and globbing. It also protects you against deleting the current working directory and above.

Install

npm install del

Usage

import {deleteAsync} from 'del';

const deletedFilePaths = await deleteAsync(['temp/*.js', '!temp/unicorn.js']);
const deletedDirectoryPaths = await deleteAsync(['temp', 'public']);

console.log('Deleted files:\n', deletedFilePaths.join('\n'));
console.log('\n\n');
console.log('Deleted directories:\n', deletedDirectoryPaths.join('\n'));

Beware

The glob pattern ** matches all children and the parent.

So this won't work:

deleteSync(['public/assets/**', '!public/assets/goat.png']);

You have to explicitly ignore the parent directories too:

deleteSync(['public/assets/**', '!public/assets', '!public/assets/goat.png']);

To delete all subdirectories inside public/, you can do:

deleteSync(['public/*/']);

Suggestions on how to improve this welcome!

API

Note that glob patterns can only contain forward-slashes, not backward-slashes. Windows file paths can use backward-slashes as long as the path does not contain any glob-like characters, otherwise use path.posix.join() instead of path.join().

deleteAsync(patterns, options?)

Returns Promise<string[]> with the deleted paths.

deleteSync(patterns, options?)

Returns string[] with the deleted paths.

patterns

Type: string | string[]

See the supported glob patterns.

options

Type: object

You can specify any of the globby options in addition to the below options. In contrast to the globby defaults, expandDirectories, onlyFiles, and followSymbolicLinks are false by default.

force

Type: boolean
Default: false

Allow deleting the current working directory and outside.

dryRun

Type: boolean
Default: false

See what would be deleted.

import {deleteAsync} from 'del';

const deletedPaths = await deleteAsync(['temp/*.js'], {dryRun: true});

console.log('Files and directories that would be deleted:\n', deletedPaths.join('\n'));
dot

Type: boolean
Default: false

Allow patterns to match files/folders that start with a period (.).

This option is passed through to fast-glob.

Note that an explicit dot in a portion of the pattern will always match dot files.

Example

directory/
├── .editorconfig
└── package.json

import {deleteSync} from 'del';

deleteSync('*', {dot: false});
//=> ['package.json']
deleteSync('*', {dot: true});
//=> ['.editorconfig', 'package.json']
concurrency

Type: number
Default: Infinity
Minimum: 1

Concurrency limit.

onProgress

Type: (progress: ProgressData) => void

Called after each file or directory is deleted.

import {deleteAsync} from 'del';

await deleteAsync(patterns, {
	onProgress: progress => {
	// …
}});
ProgressData
{
	totalCount: number,
	deletedCount: number,
	percent: number,
	path?: string
}
  • percent is a value between 0 and 1
  • path is the absolute path of the deleted file or directory. It will not be present if nothing was deleted.

CLI

See del-cli for a CLI for this module and trash-cli for a safe version that is suitable for running by hand.

Related

  • make-dir - Make a directory and its parents if needed
  • globby - User-friendly glob matching
npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc, the official website for the npm registry. Note that npm is a registered trademark of npm, Inc. Please share your feedback via our GitHub repository. For more details, please refer to our Terms & Privacy.