Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Delete files and directories
Weekly downloads
Package description
The del npm package is a powerful tool for deleting files and directories in a Node.js environment. It uses globs to select files and is built on top of the rimraf package, providing a promise-based API that supports multiple files and globbing patterns.
Delete files and directories
This feature allows you to delete files and directories using glob patterns. The example shows how to delete all JavaScript files in the 'temp' directory except 'temp/unicorn.js'.
const del = require('del');
del(['temp/*.js', '!temp/unicorn.js']).then(paths => {
console.log('Deleted files and folders:\n', paths.join('\n'));
});
Dry run
This feature performs a dry run without actually deleting the files. It's useful for testing which files would be deleted.
const del = require('del');
del(['temp/*.js'], {dryRun: true}).then(paths => {
console.log('Files and folders that would be deleted:\n', paths.join('\n'));
});
Force deletion
This feature allows you to delete files outside of the current working directory. Use with caution as it can potentially cause data loss.
const del = require('del');
del(['../temp/*.js'], {force: true}).then(paths => {
console.log('Deleted files and folders:\n', paths.join('\n'));
});
rimraf is a Node.js package that provides a UNIX command rm -rf like functionality. It is the underlying library that del uses to delete files and directories. Unlike del, rimraf does not return promises natively and does not support globbing patterns without additional modules.
fs-extra is a package that extends the built-in Node.js fs module. It includes methods like remove and emptyDir which can be used to delete files and directories. fs-extra supports promises and can be a more comprehensive file system solution, but it does not have built-in globbing support.
globby is a globbing library for Node.js that can be used in conjunction with other file system packages to delete files using patterns. It is not a direct alternative to del, but it can be used to achieve similar results when combined with fs or fs-extra.
Readme
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.
npm install del
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'));
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!
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()
.
Returns Promise<string[]>
with the deleted paths.
Returns string[]
with the deleted paths.
Type: string | string[]
See the supported glob patterns.
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.
Type: boolean
Default: false
Allow deleting the current working directory and outside.
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'));
Type: number
Default: Infinity
Minimum: 1
Concurrency limit.
Type: (progress: ProgressData) => void
Called after each file or directory is deleted.
import {deleteAsync} from 'del';
await deleteAsync(patterns, {
onProgress: progress => {
// …
}});
{
totalCount: number,
deletedCount: number,
percent: number
}
percent
is a value between 0
and 1
See del-cli for a CLI for this module and trash-cli for a safe version that is suitable for running by hand.
Available as part of the Tidelift Subscription.
The maintainers of del and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.
FAQs
Delete files and directories
The npm package del receives a total of 11,057,492 weekly downloads. As such, del popularity was classified as popular.
We found that del demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.