add escapePath utility function (#36)

Co-authored-by: Ben McCann <[email protected]>

---------

Co-authored-by: Superchupu <[email protected]>

src/index.ts

@@ -221,3 +221,5 @@ export function globSync(patternsOrOptions: string | string[] | GlobOptions, opt
 
   return crawl(opts, cwd, true);
 }
+
+export { escapePath } from './utils.ts';

src/utils.ts

@@ -0,0 +1,18 @@
+// #region escapePath
+
+/*
+  Matches the following unescaped symbols:
+  `(){}[]`, `!+@` before `(`, `!` at the beginning,
+  plus the following platform-specific symbols:
+
+  Posix: `*?|`, `\` before non-special characters.
+*/
+const POSIX_UNESCAPED_GLOB_SYMBOLS = /(?<!\\)([()[\]{}*?|]|^!|[!+@](?=\()|\\(?![()[\]{}!*+?@|]))/g;
+const WIN32_UNESCAPED_GLOB_SYMBOLS = /(?<!\\)([()[\]{}]|^!|[!+@](?=\())/g;
+
+export const escapePosixPath = (pattern: string): string => pattern.replace(POSIX_UNESCAPED_GLOB_SYMBOLS, '\\$&');
+export const escapeWin32Path = (pattern: string): string => pattern.replace(WIN32_UNESCAPED_GLOB_SYMBOLS, '\\$&');
+
+export const escapePath: (pattern: string) => string = process.platform === 'win32' ? escapeWin32Path : escapePosixPath;
+
+// #endregion

test/escapePath.test.ts

@@ -0,0 +1,36 @@
+import assert from 'node:assert/strict';
+import { describe, test } from 'node:test';
+import { escapePosixPath, escapeWin32Path } from '../src/utils.ts';
+
+for (const platform of ['win32', 'posix']) {
+  const escapePath = platform === 'posix' ? escapePosixPath : escapeWin32Path;
+
+  describe(`escapePath (${platform})`, () => {
+    test("doesn't add backslashes to already escaped patterns", () => {
+      assert.strictEqual(escapeWin32Path('\\['), '\\[');
+
+      if (platform === 'posix') {
+        assert.strictEqual(escapePath('\\|'), '\\|');
+      }
+    });
+
+    test("doesn't add wrong backslashes", () => {
+      assert.strictEqual(escapePath('hi!@+'), 'hi!@+');
+    });
+
+    test('correctly escapes characters', () => {
+      assert.strictEqual(escapePath('!nox'), '\\!nox');
+      assert.strictEqual(escapePath('hi+(@(!())))'), 'hi\\+\\(\\@\\(\\!\\(\\)\\)\\)\\)');
+
+      if (platform === 'posix') {
+        assert.strictEqual(escapePath('\\'), '\\\\');
+        assert.strictEqual(escapePath('meo*w'), 'meo\\*w');
+      } else if (platform === 'win32') {
+        assert.strictEqual(
+          escapePath('C:\\Users\\meeee\\New Folder (1)\\**'),
+          'C:\\Users\\meeee\\New Folder \\(1\\)\\**'
+        );
+      }
+    });
+  });
+}

test/index.test.ts

@@ -199,7 +199,7 @@ test('absolute + empty commonPath', async () => {
 });
 
 test('works with non-absolute cwd', async () => {
-  const files = await glob({ patterns: ['*.test.ts'], cwd: 'test' });
+  const files = await glob({ patterns: ['index.test.ts'], cwd: 'test' });
   assert.deepEqual(files.sort(), ['index.test.ts']);
 });