jonschlinkert / delete Goto Github PK

View Code? Open in Web Editor NEW

24.0 4.0 5.0 31 KB

Delete files and folders and any intermediate directories if they exist (sync and async).

Home Page: https://github.com/jonschlinkert

License: MIT License

JavaScript 100.00%

delete del remove fs file file-system glob match

delete's Introduction

delete

Delete files and folders and any intermediate directories if they exist (sync and async).

Install

Install with npm:

$ npm install --save delete

Usage

var del = require('delete');

// async
del(['foo/*.js'], function(err, deleted) {
  if (err) throw err;
  // deleted files
  console.log(deleted);
});

// sync
del.sync(['foo/*.js']);

// promise
del.promise(['foo/*.js'])
  .then(function(deleted) {
    // deleted files
    console.log(deleted)
  });

Options

All methods take an options object as the second argument.

options.force

Type: boolean

Default: undefined

By default, error is thrown if you try to delete either the current working directory itself, or files outside of the current working directory (e.g. parent directories).

Examples

del.sync('../foo.md', {force: true});

del('.', {force: true}, function(err, files) {
  // do stuff with err
  console.log(files);
});

del.promise('./', {force: true})
  .then(function(files) {
    console.log(files);
  })

(This option was inspired by settings in grunt.)

About

Related projects

copy: Copy files or directories using globs. | homepage
export-files: node.js utility for exporting a directory of files as modules. | homepage
micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage
write: Write files to disk, creating intermediate directories if they don't exist. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on July 02, 2017.

delete's People

Contributors

Stargazers

Watchers

Forkers

flyeven vivekimsit mrk-9 vamship si-creator

delete's Issues

drop the `.promise` method

Or use some promise lib or do some workaround. Currently it calls the glob.sync method which not make any sense - so, something like async response/method sync operation. With that .promise method you just return a promise, but actually behind the scenes everything is sync, nothing is async. Does make users think they really do some async operation, because they got promise, but in real it's not async.

Hope you got correctly my state. Just noticed some things and share thoughts. Dropping it make more sense instead as it is currently. Or at least, make a not on readme, imho.

Cheers.

./lib/utils missing when installing from npm

Install 0.2.0 via npm - lib/utils.js is missing from the package.

Version incompatibility

In v0.3.0 it was possible to call the async del method without a callback, in v0.3.1 this throws an error due to the callback being undefined.

I can provide a pull request if desired.

Deletion failed in other directories

build/deletePm2Logs.js

let del = require('delete')

console.log('start delete logs')

del(['../logs/*.log'], {force: true}, function(err, deleted) {
  if (err) {
    console.log('fail')
  } else {
    console.log('success');
  }
});

command:
node build/deletePm2Logs.js

It prompt success, but it's not deleted

other info:
parameter delete is empty array

Singular

The description is a bit misleading:

Delete files and folders and any intermediate directories if they exist (sync and async).

Since it only delete's one file/folder at the time, so should be (especially in package.json):

Delete a file or folder and any intermediate directories if they exist (sync and async).

Got a comment that it's confusing people on http://gulpjs.com/plugins/ since both says the same:

Would you consider removing the gulpfriendly keyword? When used with gulp you don't really care about the extra deps and want the flexibility of globs. So having two very similar things is a bit confusing to people it seems.

Package not found in npm

Hi, when I tried to install delete through npm it returns 404 Not Found
URL: https://registry.npmjs.org/delete/-/delete-1.1.0.tgz

Do you know if this package has been deleted from npm?
Thanks in advance!

jonschlinkert / delete Goto Github PK

delete's Introduction

delete

Install

Usage

Options

options.force

About

Related projects

Contributing

Building docs

Running tests

Author

License

delete's People

Contributors

Stargazers

Watchers

Forkers

delete's Issues

Recommend Projects

Recommend Topics

Recommend Org