rimraf - npm Package Compare versions

Comparing version 2.4.5 to 2.5.0

package.json

 {
   "name": "rimraf",
-  "version": "2.4.5",
+  "version": "2.5.0",
   "main": "rimraf.js",
@@ -5,0 +5,0 @@ "description": "A deep deletion module for node (like `rm -rf`)",

README.md

@@ -30,2 +30,60 @@ [![Build Status](https://travis-ci.org/isaacs/rimraf.svg?branch=master)](https://travis-ci.org/isaacs/rimraf) [![Dependency Status](https://david-dm.org/isaacs/rimraf.svg)](https://david-dm.org/isaacs/rimraf) [![devDependency Status](https://david-dm.org/isaacs/rimraf/dev-status.svg)](https://david-dm.org/isaacs/rimraf#info=devDependencies)
 
+## options
+
+* unlink, chmod, stat, lstat, rmdir, readdir
+  unlinkSync, chmodSync, statSync, lstatSync, rmdirSync, readdirSync
+
+    In order to use a custom file system library, you can override
+    specific fs functions on the options object.
+
+    If any of these functions are present on the options object, then
+    the supplied function will be used instead of the default fs
+    method.
+
+    Sync methods are only relevant for `rimraf.sync()`, of course.
+
+    For example:
+
+    ```javascript
+    var myCustomFS = require('some-custom-fs')
+
+    rimraf('some-thing', myCustomFS, callback)
+    ```
+
+* maxBusyTries
+
+    If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error code is encountered
+    on Windows systems, then rimraf will retry with a linear backoff
+    wait of 100ms longer on each try.  The default maxBusyTries is 3.
+
+    Only relevant for async usage.
+
+* emfileWait
+
+    If an `EMFILE` error is encountered, then rimraf will retry
+    repeatedly with a linear backoff of 1ms longer on each try, until
+    the timeout counter hits this max.  The default limit is 1000.
+
+    If you repeatedly encounter `EMFILE` errors, then consider using
+    [graceful-fs](http://npm.im/graceful-fs) in your program.
+
+    Only relevant for async usage.
+
+* glob
+
+    Set to `false` to disable [glob](http://npm.im/glob) pattern
+    matching.
+
+    Set to an object to pass options to the glob module.  The default
+    glob options are `{ nosort: true, silent: true }`.
+
+    Glob version 6 is used in this module.
+
+    Relevant for both sync and async usage.
+
+* disableGlob
+
+    Set to any non-falsey value to disable globbing entirely.
+    (Equivalent to setting `glob: false`.)
+
 ## rimraf.sync
@@ -32,0 +90,0 @@

rimraf.js

@@ -9,6 +9,4 @@ module.exports = rimraf
 
-var globOpts = {
+var defaultGlobOpts = {
   nosort: true,
-  nocomment: true,
-  nonegate: true,
   silent: true
@@ -39,3 +37,7 @@ }
   options.emfileWait = options.emfileWait || 1000
+  if (options.glob === false) {
+    options.disableGlob = true
+  }
   options.disableGlob = options.disableGlob || false
+  options.glob = options.glob || defaultGlobOpts
 }
@@ -68,3 +70,3 @@
 
-    glob(p, globOpts, afterGlob)
+    glob(p, options.glob, afterGlob)
   })
@@ -276,3 +278,3 @@
     } catch (er) {
-      results = glob.sync(p, globOpts)
+      results = glob.sync(p, options.glob)
     }
@@ -279,0 +281,0 @@ }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13777

increased by14.67%

Lines of code

326

increased by0.62%

Number of lines in readme file

102

increased by131.82%

No dependency changes