remove - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "remove",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Sync and async rm -r.",
-  "homepage": "http://dsc.github.com/node-remove/",
+  "homepage": "http://github.com/dsc/node-remove",
   "keywords": [
@@ -11,3 +11,6 @@ "util",
     "fs",
-    "rm"
+    "rm",
+    "remove",
+    "delete",
+    "recursive"
   ],
@@ -14,0 +17,0 @@ "author": "David Schoonover <[e-mail]> (http://less.ly)",

README.md

 # node-remove
 
-Sync and async versions of `rm -r`, handling both files and directories.
+Sync and async versions of `rm -r`, handling both files and directories (something astonishingly missing from `fs`).
+
+````js
+var remove = require('remove');
+
+// Asynchronous
+remove('/home/esr', function(err){
+    if (err) console.error(err);
+    else     console.log('success!');
+});
+
+// Synchronous
+try {
+    remove.removeSync('/home/esr');
+    console.log('success!');
+} catch (err) {
+    console.error(err);
+}
+````
+
+
+## Installation
+
+Via [npm](http://npmjs.org/):
+
+````sh
+npm install remove
+````
+
+Or if you want to hack on the source:
+
+````sh
+git clone https://github.com/dsc/node-remove.git
+cd node-remove
+npm link
+````
+
+
+## API
+
+### remove(paths, [options], cb) -> void
+### remove.removeAsync(paths, [options], cb) -> void
+
+Asynchronously and recursively remove files and/or directories.
+
+- **paths** *String | Array<String>* — Path or paths to remove.
+- **options** *Object* — Options object:
+    - **verbose** : `false` *Boolean* — Log all errors and print each path just before it's removed.
+    - **sequential** : `false` *Boolean* — If true, remove the supplied paths sequentially, such that an unsuppressed error would short-circuit further deletes.
+    - **ignoreErrors** : `false` *Boolean* — If false, halt as soon as possible after an error occurs and invoke the callback. When operating in `sequential` mode, this implies an error removing the first of several paths would halt before touching the rest. If set, `ignoreErrors` overrides `ignoreMissing`.
+    - **ignoreMissing** : `false` *Boolean* — Whether to treat missing paths as errors.
+- **callback** *Function* — Completion callback, invoked with null on success and the error on failure.
+
+
+### removeSync(paths, [options]) -> void
+
+Synchronously and recursively remove files and/or directories.
+
+- **paths** *String | Array<String>* — Path or paths to remove.
+- **options** *Object* — Options (all optional):
+    - **verbose** : `false` *Boolean* — Log all errors and print each path just before it's removed.
+    - **ignoreErrors** : `false` *Boolean* — If false, halt as soon as possible after an error occurs and invoke the callback. This implies an error removing the first of several paths would halt before touching the rest. If set, `ignoreErrors` overrides `ignoreMissing`.
+    - **ignoreMissing** : `false` *Boolean* — Whether to treat missing paths as errors.
+
+
+## Feedback
+
+Find a bug or want to contribute? Open a ticket on [github](http://github.com/dsc/node-remove).
+You're also welcome to send me email at [[e-mail]](mailto:[e-mail]?subject=node-remove).
+

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15827

increased by101.36%

Number of package files

8

increased by33.33%

Lines of code

142

increased by14100%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

73

increased by1725%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of low supply chain risk alerts

1

increased byInfinity%

No dependency changes