Change glob matcher to picomatch (#316)

* Change glob matcher to picomatch

Fixes #244

* Add more `globsToMatcher` test cases and enable `contains` option

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

Author: cometkim

package-lock.json

@@ -89,11 +89,7 @@ export class ModuleLinker {
       return module;
     }
 
-    // Find first matching module rule ("ignore" requires relative paths)
-    const relativeIdentifier = path.relative("", identifier);
-    const rule = this.moduleRules.find((rule) =>
-      rule.include.test(relativeIdentifier)
-    );
+    const rule = this.moduleRules.find((rule) => rule.include.test(identifier));
     if (rule === undefined) {
       const isBuiltin = builtinModules.includes(spec);
       const suggestion = isBuiltin ? SUGGEST_NODE : SUGGEST_BUNDLE;
@@ -183,11 +179,7 @@ export class ModuleLinker {
       return module.exports;
     }
 
-    // Find first matching module rule ("ignore" requires relative paths)
-    const relativeIdentifier = path.relative("", identifier);
-    const rule = this.moduleRules.find((rule) =>
-      rule.include.test(relativeIdentifier)
-    );
+    const rule = this.moduleRules.find((rule) => rule.include.test(identifier));
     if (rule === undefined) {
       const isBuiltin = builtinModules.includes(spec);
       const suggestion = isBuiltin ? SUGGEST_NODE : SUGGEST_BUNDLE;

packages/runner-vm/src/linker.ts

@@ -35,10 +35,11 @@
     "extends": "../../package.json"
   },
   "dependencies": {
-    "ignore": "^5.1.8",
-    "kleur": "^4.1.4"
+    "kleur": "^4.1.4",
+    "picomatch": "^2.3.1"
   },
   "devDependencies": {
-    "@miniflare/shared-test": "2.6.0"
+    "@miniflare/shared-test": "2.6.0",
+    "@types/picomatch": "^2.3.0"
   }
 }

packages/shared/package.json

@@ -1,5 +1,5 @@
 import path from "path";
-import ignore from "ignore";
+import picomatch from "picomatch";
 
 export const numericCompare = new Intl.Collator(undefined, { numeric: true })
   .compare;
@@ -44,12 +44,25 @@ export interface Matcher {
   toString(): string;
 }
 
-export function globsToMatcher(globs?: string[]): Matcher {
-  const ign = ignore();
-  if (globs) ign.add(globs);
+export function globsToMatcher(globs: string[] = []): Matcher {
+  const matchGlobs: string[] = [];
+  const ignoreGlobs: string[] = [];
+  for (const glob of globs) {
+    if (glob.startsWith("!")) {
+      ignoreGlobs.push(glob.slice(1));
+    } else {
+      matchGlobs.push(glob);
+    }
+  }
+  const isMatch = picomatch(matchGlobs, {
+    dot: true,
+    bash: true,
+    contains: true,
+    ignore: ignoreGlobs,
+  });
   return {
-    test: (string) => ign.ignores(string),
-    toString: () => globs?.join(", ") ?? "",
+    test: (string) => isMatch(string),
+    toString: () => globs.join(", "),
   };
 }
 

packages/shared/src/data.ts

@@ -60,11 +60,25 @@ test("base64Decode: decodes base64 string", (t) => {
 test("globsToMatcher: converts globs to string matcher", (t) => {
   const globs = ["*.txt", "src/**/*.js", "!src/bad.js"];
   const matcher = globsToMatcher(globs);
+
+  // Check `*.txt`
   t.true(matcher.test("test.txt"));
   t.true(matcher.test("dist/test.txt"));
+
+  // Check `src/**/*.js`
   t.true(matcher.test("src/index.js"));
   t.true(matcher.test("src/lib/add.js"));
+  t.false(matcher.test("src/image.jpg"));
+
+  // Check `!src/bad.js`
   t.false(matcher.test("src/bad.js"));
+
+  // Check absolute paths (`ModuleLinker` will `path.resolve` to absolute paths)
+  // (see https://github.com/cloudflare/miniflare/issues/244)
+  t.true(matcher.test("/one/two/three.txt"));
+  t.true(matcher.test(path.join(process.cwd(), "src/index.js")));
+
+  // Check debug output
   t.is(matcher.toString(), globs.join(", "));
 });
 test("globsToMatcher: returns matcher that matches nothing on undefined globs", (t) => {