chore: verify that micromatch update does not break CSpell. (#5650)

streetsidesoftware · May 21, 2024 · 5ece92b · 5ece92b
1 parent a57de4f
commit 5ece92b
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 49 deletions.
diff --git a/packages/cspell-glob/package.json b/packages/cspell-glob/package.json
@@ -50,7 +50,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "micromatch": "4.0.5"
+    "micromatch": "^4.0.6"
   },
   "devDependencies": {
     "@types/micromatch": "^4.0.7"

diff --git a/packages/cspell-glob/src/GlobMatcher.test.ts b/packages/cspell-glob/src/GlobMatcher.test.ts
@@ -12,6 +12,7 @@ import type {
     GlobPatternWithOptionalRoot,
     PathInterface,
 } from './GlobMatcherTypes.js';
+import { fileURLToPath } from 'node:url';
 
 const defaultCwdWin32 = 'C:\\user\\home\\project\\testing';
 const defaultCwdPosix = '/user/home/project/testing';
@@ -26,6 +27,8 @@ const pathPosix: PathInterface = {
     resolve: (...paths) => path.posix.resolve(defaultCwdPosix, ...paths),
 };
 
+const __filename = fileURLToPath(import.meta.url);
+
 const pathNames = new Map([
     [pathWin32, 'Win32'],
     [pathPosix, 'Posix'],
@@ -55,34 +58,37 @@ describe('Validate assumptions', () => {
 
 describe('Validate Micromatch assumptions', () => {
     test.each`
-        glob                       | filename                      | expectedToMatch
-        ${'*.json'}                | ${'settings.json'}            | ${true}
-        ${'*.json'}                | ${'/settings.json'}           | ${false}
-        ${'*.json'}                | ${'src/settings.json'}        | ${false}
-        ${'*.json'}                | ${'/src/settings.json'}       | ${false}
-        ${'**/*.json'}             | ${'settings.json'}            | ${true}
-        ${'**/*.json'}             | ${'/settings.json'}           | ${true}
-        ${'**/*.json'}             | ${'src/settings.json'}        | ${true}
-        ${'**/*.json'}             | ${'/src/settings.json'}       | ${true}
-        ${'**/temp'}               | ${'/src/temp/data.json'}      | ${false}
-        ${'**/temp/'}              | ${'/src/temp/data.json'}      | ${false}
-        ${'**/temp/**'}            | ${'/src/temp/data.json'}      | ${true}
-        ${'src/*.json'}            | ${'src/settings.json'}        | ${true}
-        ${'**/{*.json,*.json/**}'} | ${'settings.json'}            | ${true}
-        ${'**/{*.json,*.json/**}'} | ${'/settings.json'}           | ${true}
-        ${'**/{*.json,*.json/**}'} | ${'src/settings.json'}        | ${true}
-        ${'**/{*.json,*.json/**}'} | ${'src/settings.json/config'} | ${true}
-        ${'**/{*.json,*.json/**}'} | ${'settings.json/config'}     | ${true}
-        ${'src/*.{test,spec}.ts'}  | ${'src/code.test.ts'}         | ${true}
-        ${'src/*.(test|spec).ts'}  | ${'src/code.test.ts'}         | ${true}
-        ${'src/*.(test|spec).ts'}  | ${'src/code.spec.ts'}         | ${true}
-        ${'src/*.(test|spec).ts'}  | ${'src/deep.code.test.ts'}    | ${true}
-        ${'src/*.(test|spec).ts'}  | ${'src/test.ts'}              | ${false}
+        glob                             | filename                      | expectedToMatch
+        ${'*.json'}                      | ${'settings.json'}            | ${true}
+        ${'*.json'}                      | ${'/settings.json'}           | ${false}
+        ${'*.json'}                      | ${'src/settings.json'}        | ${false}
+        ${'*.json'}                      | ${'/src/settings.json'}       | ${false}
+        ${'**/*.json'}                   | ${'settings.json'}            | ${true}
+        ${'**/*.json'}                   | ${'/settings.json'}           | ${true}
+        ${'**/*.json'}                   | ${'src/settings.json'}        | ${true}
+        ${'**/*.json'}                   | ${'/src/settings.json'}       | ${true}
+        ${'**/temp'}                     | ${'/src/temp/data.json'}      | ${false}
+        ${'**/temp/'}                    | ${'/src/temp/data.json'}      | ${false}
+        ${'**/temp/**'}                  | ${'/src/temp/data.json'}      | ${true}
+        ${'src/*.json'}                  | ${'src/settings.json'}        | ${true}
+        ${'**/{*.json,*.json/**}'}       | ${'settings.json'}            | ${true}
+        ${'**/{*.json,*.json/**}'}       | ${'/settings.json'}           | ${true}
+        ${'**/{*.json,*.json/**}'}       | ${'src/settings.json'}        | ${true}
+        ${'**/{*.json,*.json/**}'}       | ${'src/settings.json/config'} | ${true}
+        ${'**/{*.json,*.json/**}'}       | ${'settings.json/config'}     | ${true}
+        ${'src/*.{test,spec}.ts'}        | ${'src/code.test.ts'}         | ${true}
+        ${'src/*.(test|spec).ts'}        | ${'src/code.test.ts'}         | ${true}
+        ${'src/*.(test|spec).ts'}        | ${'src/code.spec.ts'}         | ${true}
+        ${'src/*.(test|spec).ts'}        | ${'src/deep.code.test.ts'}    | ${true}
+        ${'src/*.(test|spec).ts'}        | ${'src/test.ts'}              | ${false}
+        ${filenameToGlob(__filename, 1)} | ${__filename}                 | ${true}
+        ${filenameToGlob(__filename, 2)} | ${__filename}                 | ${true}
     `(
         `Micromatch glob: '$glob', filename: '$filename' expected: $expectedToMatch`,
         ({ glob, filename, expectedToMatch }) => {
-            const reg1 = mm.makeRe(glob);
-            expect(reg1.test(filename)).toEqual(expectedToMatch);
+            const reg = mm.makeRe(glob);
+            expect(reg.test(filename)).toEqual(expectedToMatch);
+            expect(mm.isMatch(filename, glob, { windows: path.sep === '\\' })).toBe(expectedToMatch);
         },
     );
 });
@@ -123,6 +129,14 @@ function resolveFilename(pathInstance: PathInterface, filename: string | undefin
     });
 });
 
+describe('Validate GlobMatcher on Windows', () => {
+    test('Make sure it works on Windows', () => {
+        const glob = filenameToGlob(__filename, 3);
+        const matcher = new GlobMatcher(glob);
+        expect(matcher.match(__filename)).toBe(true);
+    });
+});
+
 describe('Tests .gitignore file contents', () => {
     const pattern = `
         # This is a comment
@@ -692,3 +706,8 @@ function resolvePattern(p: GlobPattern | GlobPattern[], path: PathInterface): Gl
         root: path.resolve(p.root),
     };
 }
+
+function filenameToGlob(filename: string, segments: number = 1) {
+    const parts = filename.split(path.sep).slice(-segments).join('/');
+    return '**/' + parts;
+}
diff --git a/packages/cspell/package.json b/packages/cspell/package.json
@@ -109,7 +109,7 @@
     "@types/glob": "^8.1.0",
     "@types/micromatch": "^4.0.7",
     "@types/semver": "^7.5.8",
-    "micromatch": "^4.0.5",
+    "micromatch": "^4.0.6",
     "minimatch": "^9.0.4"
   }
 }
diff --git a/packages/cspell/src/app/util/glob.test.ts b/packages/cspell/src/app/util/glob.test.ts
@@ -264,7 +264,7 @@ describe('Validate internal functions', () => {
             const relToRoot = path.relative(root, file);
 
             expect(globMatcher.match(file)).toBe(expectedToMatch);
-            expect(micromatch.isMatch(relToRoot, expectedGlobs)).toBe(expectedToMatch);
+            expect(micromatch.isMatch(relToRoot, expectedGlobs, { windows: path.sep === '\\' })).toBe(expectedToMatch);
         },
     );
 });
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml