add support for custom fs override option

Fix: #280

Author: isaacs

README.md

@@ -366,6 +366,10 @@ share the previously loaded cache.
 - `signal` An AbortSignal which will cancel the Glob walk when
   triggered.
 
+- `fs` An override object to pass in custom filesystem methods.
+  See [PathScurry docs](http://npm.im/path-scurry) for what can
+  be overridden.
+
 - `scurry` A [PathScurry](http://npm.im/path-scurry) object used
   to traverse the file system. If the `nocase` option is set
   explicitly, then any provided `scurry` object must match this

changelog.md

@@ -1,3 +1,9 @@
+# cganhe glo
+
+## 9.2
+
+- Support using a custom fs object, which is passed to PathScurry
+
 ## 9.1
 
 - Bring back the `root` option, albeit with slightly different

src/glob.ts

@@ -1,6 +1,7 @@
 import { Minimatch, MinimatchOptions } from 'minimatch'
 import Minipass from 'minipass'
 import {
+  FSOption,
   Path,
   PathScurry,
   PathScurryDarwin,
@@ -240,6 +241,12 @@ export interface GlobOptions {
    * Conflicts with {@link absolute}
    */
   withFileTypes?: boolean
+
+  /**
+   * An fs implementation to override some or all of the defaults.  See
+   * http://npm.im/path-scurry for details about what can be overridden.
+   */
+  fs?: FSOption
 }
 
 export type GlobOptionsWithFileTypesTrue = GlobOptions & {
@@ -389,7 +396,10 @@ export class Glob<Opts extends GlobOptions> implements GlobOptions {
           : opts.platform
           ? PathScurryPosix
           : PathScurry
-      this.scurry = new Scurry(this.cwd, { nocase: opts.nocase })
+      this.scurry = new Scurry(this.cwd, {
+        nocase: opts.nocase,
+        fs: opts.fs,
+      })
     }
     this.nocase = this.scurry.nocase
 

test/custom-fs.ts

@@ -0,0 +1,30 @@
+import t from 'tap'
+import { globSync } from '../'
+
+// just a rudimentary test, since PathScurry tests it more anyway
+import { readdirSync } from 'fs'
+let readdirCalled = 0
+const myReaddirSync = (path: string, options: { withFileTypes: true }) => {
+  readdirCalled++
+  return readdirSync(path, options)
+}
+
+const cwd = t.testdir({
+  a: '',
+  b: '',
+  c: {},
+})
+
+t.same(
+  new Set(['a', 'b', 'c', '']),
+  new Set(
+    globSync('**', {
+      fs: {
+        readdirSync: myReaddirSync,
+      },
+      cwd,
+    })
+  )
+)
+
+t.equal(readdirCalled, 2)