3.0.1 • Published 6 years ago

del-cr v3.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

del-cr - a del fork Build Status XO code style

Delete files and folders 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 --save del-cr

Usage

const del = require('del-cr');

del(['tmp/*.js', '!tmp/unicorn.js']).then(paths => {
	console.log('Deleted files and folders:\n', paths.join('\n'));
});

Beware

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

So this won't work:

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

You have to explicitly ignore the parent directories too:

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

Suggestions on how to improve this welcome!

API

del(patterns, options)

Returns a promise for an array of deleted paths.

del.sync(patterns, options)

Returns an array of deleted paths.

patterns

Type: string Array

See supported minimatch patterns.

options

Type: Object

See the glob options.

force

Type: boolean Default: false

Allow deleting the current working directory and outside.

dryRun

Type: boolean Default: false

See what would be deleted.

const del = require('del-cr');

del(['tmp/*.js'], {dryRun: true}).then(paths => {
	console.log('Files and folders that would be deleted:\n', paths.join('\n'));
});
concurrency

Type: number Default: Infinity Minimum: 1

Concurrency limit.

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

License

Original work by: MIT © Sindre Sorhus

MIT © niktekusho