feat: migrate minimatch to picomatch (#240)

Author: JounQin

.changeset/chilly-weeks-sit.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+feat: migrate `minimatch` to `picomatch`

.gitignore

@@ -1,44 +1,26 @@
 # Logs
-logs
 *.log
 
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
 # Coverage directory used by tools like istanbul
 coverage
 
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directory
-# Commenting this out is preferred by some people, see
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
 node_modules
 !test/**/node_modules/
 
-# Users Environment Variables
-.lock-wscript
-
 # added by GitSavvy
 *.sublime-workspace
 
 # generated output
-lib/
-**/.nyc_output/
+lib
 
 # macOS
 .DS_Store
+
+# Cache
 .*cache
 
+# Yarn Berry
 .yarn/*
 !.yarn/patches
 !.yarn/plugins

package.json

@@ -54,8 +54,7 @@
     "doctrine": "^3.0.0",
     "eslint-import-resolver-node": "^0.3.9",
     "get-tsconfig": "^4.10.0",
-    "is-glob": "^4.0.3",
-    "minimatch": "^10.0.1",
+    "picomatch": "^4.0.2",
     "rspack-resolver": "^1.1.0",
     "semver": "^7.7.1",
     "stable-hash": "^0.0.5",
@@ -90,19 +89,18 @@
     "@types/debug": "^4.1.12",
     "@types/eslint": "^9.6.1",
     "@types/eslint8.56": "npm:@types/eslint@~8.56.0",
-    "@types/is-glob": "^4.0.4",
     "@types/jest": "^29.5.14",
     "@types/json-schema": "^7.0.15",
     "@types/klaw-sync": "^6.0.5",
     "@types/node": "^20.17.24",
+    "@types/picomatch": "^3.0.2",
     "@types/pnpapi": "^0.0.5",
     "@typescript-eslint/eslint-plugin": "^8.26.1",
     "@typescript-eslint/parser": "^8.26.1",
     "@typescript-eslint/rule-tester": "^8.26.1",
     "@unts/patch-package": "^8.1.1",
     "clean-pkg-json": "^1.2.1",
     "cross-env": "^7.0.3",
-    "escope": "^4.0.0",
     "eslint": "^9.22.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-doc-generator": "^2.1.1",

src/node-resolver.ts

@@ -53,12 +53,17 @@ export function createNodeResolver({
         return { found: true, path: null }
       }
 
+      /**
+       * {@link https://github.com/webpack/enhanced-resolve/blob/38e9fd9acb79643a70e7bcd0d85dabc600ea321f/lib/PnpPlugin.js#L81-L83}
+       */
       if (process.versions.pnp && modulePath === 'pnpapi') {
         return {
           found: true,
           path: module
             .findPnpApi(sourceFile)
-            .resolveToUnqualified(modulePath, null),
+            .resolveToUnqualified(modulePath, sourceFile, {
+              considerBuiltins: false,
+            }),
         }
       }
 

src/rules/no-extraneous-dependencies.ts

@@ -2,7 +2,6 @@ import fs from 'node:fs'
 import path from 'node:path'
 
 import type { TSESTree } from '@typescript-eslint/utils'
-import { minimatch } from 'minimatch'
 import type { PackageJson } from 'type-fest'
 
 import type { RuleContext } from '../types'
@@ -13,6 +12,7 @@ import {
   pkgUp,
   importType,
   getFilePackageName,
+  isFileMatch,
 } from '../utils'
 
 type PackageDeps = ReturnType<typeof extractDepFields>
@@ -329,16 +329,11 @@ function reportIfMissing(
 }
 
 function testConfig(config: string[] | boolean | undefined, filename: string) {
-  // Simplest configuration first, either a boolean or nothing.
-  if (typeof config === 'boolean' || config === undefined) {
-    return config
-  }
-  // Array of globs.
-  return config.some(
-    c =>
-      minimatch(filename, c) ||
-      minimatch(filename, path.resolve(c), { windowsPathsNoEscape: true }),
-  )
+  return Array.isArray(config)
+    ? // Array of globs.
+      isFileMatch(filename, config)
+    : // Simplest configuration first, either a boolean or nothing.
+      config
 }
 
 type Options = {

src/rules/no-import-module-exports.ts

@@ -1,10 +1,9 @@
 import path from 'node:path'
 
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import { minimatch } from 'minimatch'
 
 import type { RuleContext } from '../types'
-import { createRule, pkgUp } from '../utils'
+import { createRule, matcher, pkgUp } from '../utils'
 
 function getEntryPoint(context: RuleContext) {
   const pkgPath = pkgUp({
@@ -79,6 +78,8 @@ export = createRule<[Options?], MessageId>({
 
     let alreadyReported = false
 
+    const isMatch = matcher(options.exceptions)
+
     return {
       ImportDeclaration(node) {
         importDeclarations.push(node)
@@ -106,15 +107,12 @@ export = createRule<[Options?], MessageId>({
         const isImportBinding = variableDefinition?.type === 'ImportBinding'
         const hasCJSExportReference =
           hasKeywords && (!objectScope || objectScope.type === 'module')
-        const isException = !!options.exceptions?.some(glob =>
-          minimatch(filename, glob),
-        )
 
         if (
           isIdentifier &&
           hasCJSExportReference &&
           !isEntryPoint &&
-          !isException &&
+          !isMatch(filename) &&
           !isImportBinding
         ) {
           for (const importDeclaration of importDeclarations) {

src/rules/no-internal-modules.ts

@@ -1,8 +1,12 @@
-import { makeRe } from 'minimatch'
-
-import { importType, createRule, moduleVisitor, resolve } from '../utils'
-
-// minimatch patterns are expected to use / path separators, like import
+import {
+  importType,
+  createRule,
+  moduleVisitor,
+  resolve,
+  matcher,
+} from '../utils'
+
+// picomatch patterns are expected to use / path separators, like import
 // statements, so normalize paths to use the same
 function normalizeSep(somePath: string) {
   return somePath.split('\\').join('/')
@@ -80,21 +84,21 @@ export = createRule<[Options?], MessageId>({
   defaultOptions: [],
   create(context) {
     const options = context.options[0] || {}
-    const allowRegexps = (options.allow || [])
-      .map(p => makeRe(p))
+    const allowMatches = (options.allow || [])
+      .map(p => matcher(p))
       .filter(Boolean)
-    const forbidRegexps = (options.forbid || [])
-      .map(p => makeRe(p))
+    const forbidMatches = (options.forbid || [])
+      .map(p => matcher(p))
       .filter(Boolean)
 
     // test if reaching to this destination is allowed
     function reachingAllowed(importPath: string) {
-      return allowRegexps.some(re => re.test(importPath))
+      return allowMatches.some(m => m(importPath))
     }
 
     // test if reaching to this destination is forbidden
     function reachingForbidden(importPath: string) {
-      return forbidRegexps.some(re => re.test(importPath))
+      return forbidMatches.some(m => m(importPath))
     }
 
     function isAllowViolation(importPath: string) {

src/rules/no-namespace.ts

@@ -3,9 +3,8 @@
  */
 
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import { minimatch } from 'minimatch'
 
-import { createRule } from '../utils'
+import { createRule, matcher } from '../utils'
 
 type MessageId = 'noNamespace'
 
@@ -45,17 +44,11 @@ export = createRule<[Options?], MessageId>({
     const firstOption = context.options[0] || {}
     const ignoreGlobs = firstOption.ignore
 
+    const isMatch = matcher(ignoreGlobs, { matchBase: true })
+
     return {
       ImportNamespaceSpecifier(node) {
-        if (
-          ignoreGlobs?.find(glob =>
-            minimatch(
-              (node.parent as TSESTree.ImportDeclaration).source.value,
-              glob,
-              { matchBase: true },
-            ),
-          )
-        ) {
+        if (isMatch(node.parent.source.value)) {
           return
         }
 

src/rules/no-restricted-paths.ts

@@ -1,21 +1,26 @@
 import path from 'node:path'
 
 import type { TSESTree } from '@typescript-eslint/utils'
-import isGlob from 'is-glob'
-import { Minimatch } from 'minimatch'
 
 import type { Arrayable } from '../types'
-import { importType, createRule, moduleVisitor, resolve } from '../utils'
+import {
+  importType,
+  createRule,
+  moduleVisitor,
+  resolve,
+  isDynamicPattern,
+  fileMatcher,
+  isMatch,
+} from '../utils'
 
 const containsPath = (filepath: string, target: string) => {
   const relative = path.relative(target, filepath)
   return relative === '' || !relative.startsWith('..')
 }
 
 function isMatchingTargetPath(filename: string, targetPath: string) {
-  if (isGlob(targetPath)) {
-    const mm = new Minimatch(targetPath, { windowsPathsNoEscape: true })
-    return mm.match(filename)
+  if (isDynamicPattern(targetPath)) {
+    return isMatch(filename, targetPath)
   }
 
   return containsPath(filename, targetPath)
@@ -171,17 +176,13 @@ export = createRule<[Options?], MessageId>({
     ) {
       let isPathException: ((absoluteImportPath: string) => boolean) | undefined
 
-      const mm = new Minimatch(absoluteFrom, { windowsPathsNoEscape: true })
-      const isPathRestricted = (absoluteImportPath: string) =>
-        mm.match(absoluteImportPath)
-      const hasValidExceptions = zoneExcept.every(it => isGlob(it))
+      const isPathRestricted = fileMatcher(absoluteFrom)
+      const hasValidExceptions = zoneExcept.every(it => isDynamicPattern(it))
 
       if (hasValidExceptions) {
-        const exceptionsMm = zoneExcept.map(
-          except => new Minimatch(except, { windowsPathsNoEscape: true }),
-        )
+        const exceptionsMm = zoneExcept.map(except => fileMatcher(except))
         isPathException = (absoluteImportPath: string) =>
-          exceptionsMm.some(mm => mm.match(absoluteImportPath))
+          exceptionsMm.some(mm => mm(absoluteImportPath))
       }
 
       const reportInvalidException = reportInvalidExceptionGlob
@@ -258,7 +259,7 @@ export = createRule<[Options?], MessageId>({
       zoneExcept: string[] = [],
     ) => {
       const allZoneFrom = [zoneFrom].flat()
-      const areGlobPatterns = allZoneFrom.map(it => isGlob(it))
+      const areGlobPatterns = allZoneFrom.map(it => isDynamicPattern(it))
 
       if (areBothGlobPatternAndAbsolutePath(areGlobPatterns)) {
         return [computeMixedGlobAndAbsolutePathValidator()]

src/rules/no-unassigned-import.ts

@@ -1,8 +1,6 @@
 import path from 'node:path'
 
-import { minimatch } from 'minimatch'
-
-import { isStaticRequire, createRule } from '../utils'
+import { isStaticRequire, createRule, isFileMatch } from '../utils'
 
 function testIsAllow(
   globs: string[] | undefined,
@@ -15,15 +13,11 @@ function testIsAllow(
 
   const filePath =
     // a node module
-    source[0] !== '.' && source[0] !== path.sep
+    source[0] !== '.' && source[0] !== '/'
       ? source
-      : path.resolve(path.dirname(filename), source) // get source absolute path
+      : path.resolve(filename, '..', source) // get source absolute path
 
-  return globs.some(
-    glob =>
-      minimatch(filePath, glob) ||
-      minimatch(filePath, path.resolve(glob), { windowsPathsNoEscape: true }),
-  )
+  return isFileMatch(filePath, globs)
 }
 
 type Options = {

src/rules/order.ts

@@ -1,6 +1,5 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import { minimatch } from 'minimatch'
-import type { MinimatchOptions } from 'minimatch'
+import type { PicomatchOptions } from 'picomatch'
 
 import type {
   AlphabetizeOptions,
@@ -9,7 +8,7 @@ import type {
   PathGroup,
   RuleContext,
 } from '../types'
-import { importType, isStaticRequire, createRule } from '../utils'
+import { importType, isStaticRequire, createRule, isMatch } from '../utils'
 
 type ImportEntryWithRank = {
   rank: number
@@ -502,7 +501,7 @@ type Ranks = {
   groups: Record<string, number>
   pathGroups: Array<{
     pattern: string
-    patternOptions?: MinimatchOptions
+    patternOptions?: PicomatchOptions
     group: string
     position?: number
   }>
@@ -519,7 +518,7 @@ function computePathRank(
 ) {
   for (let i = 0, l = pathGroups.length; i < l; i++) {
     const { pattern, patternOptions, group, position = 1 } = pathGroups[i]
-    if (minimatch(path, pattern, patternOptions || { nocomment: true })) {
+    if (isMatch(path, pattern, patternOptions)) {
       return ranks[group] + position / maxPosition
     }
   }