Add posix: boolean option to return / paths

isaacs · isaacs · commit a1cba4da1612 · 2023-04-14T16:14:56.000-07:00
Fix: #520
diff --git a/README.md b/README.md
@@ -430,6 +430,13 @@ share the previously loaded cache.
 
   `absolute` may not be used along with `withFileTypes`.
 
+- `posix` Set to true to use `/` as the path separator in
+  returned results.  On posix systems, this has no effect.  On
+  Windows systems, this will return `/` delimited path results,
+  and absolute paths will be returned in their full resolved UNC
+  path form, eg insted of `'C:\\foo\\bar'`, it will return
+  `//?/C:/foo/bar`.
+
 - `platform` Defaults to value of `process.platform` if
   available, or `'linux'` if not. Setting `platform:'win32'` on
   non-Windows systems may cause strange behavior.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -62,7 +62,7 @@
     "fs.realpath": "^1.0.0",
     "minimatch": "^9.0.0",
     "minipass": "^5.0.0",
-    "path-scurry": "^1.6.4"
+    "path-scurry": "^1.7.0"
   },
   "devDependencies": {
     "@types/node": "^18.11.18",
diff --git a/src/glob.ts b/src/glob.ts
@@ -282,11 +282,24 @@ export interface GlobOptions {
    * matching operations slower and *extremely* noisy.
    */
   debug?: boolean
+
+  /**
+   * Return `/` delimited paths, even on Windows.
+   *
+   * On posix systems, this has no effect.  But, on Windows, it means that
+   * paths will be `/` delimited, and absolute paths will be their full
+   * resolved UNC forms, eg instead of `'C:\\foo\\bar'`, it would return
+   * `'//?/C:/foo/bar'`
+   */
+  posix?: boolean
 }
 
 export type GlobOptionsWithFileTypesTrue = GlobOptions & {
   withFileTypes: true
+  // string options not relevant if returning Path objects.
   absolute?: undefined
+  mark?: undefined
+  posix?: undefined
 }
 
 export type GlobOptionsWithFileTypesFalse = GlobOptions & {
diff --git a/src/walker.ts b/src/walker.ts
@@ -35,6 +35,7 @@ export interface GlobWalkerOpts {
   noext?: boolean
   noglobstar?: boolean
   platform?: NodeJS.Platform
+  posix?: boolean
   realpath?: boolean
   root?: string
   stat?: boolean
@@ -109,7 +110,7 @@ export abstract class GlobUtil<O extends GlobWalkerOpts = GlobWalkerOpts> {
     this.patterns = patterns
     this.path = path
     this.opts = opts
-    this.#sep = opts.platform === 'win32' ? '\\' : '/'
+    this.#sep = !opts.posix && opts.platform === 'win32' ? '\\' : '/'
     if (opts.ignore) {
       this.#ignore = makeIgnore(opts.ignore, opts)
     }
@@ -207,9 +208,10 @@ export abstract class GlobUtil<O extends GlobWalkerOpts = GlobWalkerOpts> {
     if (this.opts.withFileTypes) {
       this.matchEmit(e)
     } else if (abs) {
-      this.matchEmit(e.fullpath() + mark)
+      const abs = this.opts.posix ? e.fullpathPosix() : e.fullpath()
+      this.matchEmit(abs + mark)
     } else {
-      const rel = e.relative()
+      const rel = this.opts.posix ? e.relativePosix() : e.relative()
       const pre =
         this.opts.dotRelative && !rel.startsWith('..' + this.#sep)
           ? '.' + this.#sep
diff --git a/test/mark.ts b/test/mark.ts
@@ -1,9 +1,9 @@
+import { sep } from 'path'
 import t from 'tap'
 import { glob } from '../'
 process.chdir(__dirname + '/fixtures')
 
 const alphasort = (a: string, b: string) => a.localeCompare(b, 'en')
-import { sep } from 'path'
 const j = (a: string[]) =>
   a.map(s => s.split('/').join(sep)).sort(alphasort)
 
@@ -146,11 +146,14 @@ for (const mark of [true, false]) {
   for (const slash of [true, false]) {
     t.test('cwd mark:' + mark + ' slash:' + slash, async t => {
       const pattern = cwd + (slash ? '/' : '')
-      const results = await glob(pattern, { mark })
+      const results = await glob(pattern, { mark, posix: true })
       t.equal(results.length, 1)
-      const res = results[0].replace(/\\/g, '/')
-      const syncResults = glob.globSync(pattern, { mark: mark })
-      const syncRes = syncResults[0].replace(/\\/g, '/')
+      const res = results[0]
+      const syncResults = glob.globSync(pattern, {
+        mark: mark,
+        posix: true,
+      })
+      const syncRes = syncResults[0]
       if (mark) {
         t.equal(res, cwd + '/')
       } else {
diff --git a/test/windows-paths-fs.ts b/test/windows-paths-fs.ts
@@ -31,9 +31,7 @@ t.test('treat backslash as escape', t => {
   for (const [pattern, expect] of cases) {
     t.test(pattern, async t => {
       t.strictSame(
-        glob
-          .globSync(pattern, { cwd: dir })
-          .map(s => s.replace(/\\/g, '/')),
+        glob.globSync(pattern, { cwd: dir, posix: true }),
         expect,
         'sync'
       )
