feat(packageRules)!: support glob/regex patterns for matchPackageNames (

#28551)

docs/usage/configuration-options.md

@@ -2830,10 +2830,22 @@ It is recommended that you avoid using "negative" globs, like `**/!(package.json
 
 ### matchDepNames
 
+This field behaves the same as `matchPackageNames` except it matches against `depName` instead of `packageName`.
+
 ### matchDepPatterns
 
+<!-- prettier-ignore -->
+!!! note
+    `matchDepNames` now supports pattern matching and should be used instead.
+    Use of `matchDepPatterns` is now deprecated and will be migrated in future.
+
 ### matchDepPrefixes
 
+<!-- prettier-ignore -->
+!!! note
+    `matchDepNames` now supports pattern matching and should be used instead.
+    Use of `matchDepPrefixes` is now deprecated and will be migrated in future.
+
 ### matchNewValue
 
 This option is matched against the `newValue` field of a dependency.
@@ -2870,54 +2882,68 @@ For more details on this syntax see Renovate's [string pattern matching document
 
 ### matchPackageNames
 
-Use this field if you want to have one or more exact name matches in your package rule.
-See also `excludePackageNames`.
+Use this field to match against the `packageName` field.
+This matching can be an exact match, Glob match, or Regular Expression match.
 
-```json
+For more details on supported syntax see Renovate's [string pattern matching documentation](./string-pattern-matching.md).
+Note that Glob matching (including exact name matching) is case-insensitive.
+
+```json title="exact name match"
 {
   "packageRules": [
     {
+      "matchDatasources": ["npm"],
       "matchPackageNames": ["angular"],
       "rangeStrategy": "pin"
     }
   ]
 }
 ```
 
-The above will configure `rangeStrategy` to `pin` only for the package `angular`.
-
-<!-- prettier-ignore -->
-!!! note
-    `matchPackageNames` will try matching `packageName` first and then fall back to matching `depName`.
-    If the fallback is used, Renovate will log a warning, because the fallback will be removed in a future release.
-    Use `matchDepNames` instead.
+The above will configure `rangeStrategy` to `pin` only for the npm package `angular`.
 
-### matchPackagePatterns
+```json title="prefix match using Glob"
+{
+  "packageRules": [
+    {
+      "matchDatasources": ["npm"],
+      "matchPackageNames": ["@angular/*", "!@angular/abc"],
+      "groupName": "Angular"
+    }
+  ]
+}
+```
 
-Use this field if you want to have one or more package names patterns in your package rule.
-See also `excludePackagePatterns`.
+The above will group together any npm package which starts with `@angular/` except `@angular/abc`.
 
-```json
+```json title="pattern match using RegEx"
 {
   "packageRules": [
     {
-      "matchPackagePatterns": ["^angular"],
-      "rangeStrategy": "replace"
+      "matchDatasources": ["npm"],
+      "matchPackageNames": ["/^angular/"],
+      "groupName": "Angular"
     }
   ]
 }
 ```
 
-The above will configure `rangeStrategy` to `replace` for any package starting with `angular`.
+The above will group together any npm package which starts with the string `angular`.
+
+### matchPackagePatterns
 
 <!-- prettier-ignore -->
 !!! note
-    `matchPackagePatterns` will try matching `packageName` first and then fall back to matching `depName`.
-    If the fallback is used, Renovate will log a warning, because the fallback will be removed in a future release.
-    Use `matchDepPatterns` instead.
+    `matchPackageNames` now supports pattern matching and should be used instead.
+    Use of `matchPackagePatterns` is now deprecated and will be migrated in future.
 
 ### matchPackagePrefixes
 
+<!-- prettier-ignore -->
+!!! note
+    `matchPackageNames` now supports pattern matching and should be used instead.
+    Use of `matchPackagePrefixes` is now deprecated and will be migrated in future.
+
 Use this field to match a package prefix without needing to write a regex expression.
 See also `excludePackagePrefixes`.
 
@@ -2934,12 +2960,6 @@ See also `excludePackagePrefixes`.
 
 Like the earlier `matchPackagePatterns` example, the above will configure `rangeStrategy` to `replace` for any package starting with `angular`.
 
-<!-- prettier-ignore -->
-!!! note
-    `matchPackagePrefixes` will try matching `packageName` first and then fall back to matching `depName`.
-    If the fallback is used, Renovate will log a warning, because the fallback will be removed in a future release.
-    Use `matchDepPatterns` instead.
-
 ### matchSourceUrlPrefixes
 
 Here's an example of where you use this to group together all packages from the `renovatebot` GitHub org:

lib/util/package-rules/dep-names.ts

@@ -1,5 +1,6 @@
 import is from '@sindresorhus/is';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
+import { matchRegexOrGlobList } from '../string-match';
 import { Matcher } from './base';
 
 export class DepNameMatcher extends Matcher {
@@ -13,7 +14,7 @@ export class DepNameMatcher extends Matcher {
     if (is.undefined(depName)) {
       return false;
     }
-    return matchDepNames.includes(depName);
+    return matchRegexOrGlobList(depName, matchDepNames);
   }
 
   override excludes(
@@ -26,6 +27,6 @@ export class DepNameMatcher extends Matcher {
     if (is.undefined(depName)) {
       return false;
     }
-    return excludeDepNames.includes(depName);
+    return matchRegexOrGlobList(depName, excludeDepNames);
   }
 }

lib/util/package-rules/dep-patterns.spec.ts

@@ -15,6 +15,30 @@ describe('util/package-rules/dep-patterns', () => {
       );
       expect(result).toBeFalse();
     });
+
+    it('should massage wildcards', () => {
+      const result = depPatternsMatcher.matches(
+        {
+          depName: 'http',
+        },
+        {
+          matchDepPatterns: ['*'],
+        },
+      );
+      expect(result).toBeTrue();
+    });
+
+    it('should convert to regex', () => {
+      const result = depPatternsMatcher.matches(
+        {
+          depName: 'http',
+        },
+        {
+          matchDepPatterns: ['^h'],
+        },
+      );
+      expect(result).toBeTrue();
+    });
   });
 
   describe('exclude', () => {
@@ -29,5 +53,29 @@ describe('util/package-rules/dep-patterns', () => {
       );
       expect(result).toBeFalse();
     });
+
+    it('should massage wildcards', () => {
+      const result = depPatternsMatcher.excludes(
+        {
+          depName: 'http',
+        },
+        {
+          excludeDepPatterns: ['*'],
+        },
+      );
+      expect(result).toBeTrue();
+    });
+
+    it('should convert to regex', () => {
+      const result = depPatternsMatcher.excludes(
+        {
+          depName: 'http',
+        },
+        {
+          excludeDepPatterns: ['^h'],
+        },
+      );
+      expect(result).toBeTrue();
+    });
   });
 });

lib/util/package-rules/dep-patterns.ts

@@ -1,13 +1,11 @@
 import is from '@sindresorhus/is';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
-import { logger } from '../../logger';
-import { regEx } from '../regex';
+import { matchRegexOrGlobList } from '../string-match';
 import { Matcher } from './base';
-import { massagePattern } from './utils';
 
 export class DepPatternsMatcher extends Matcher {
   override matches(
-    { depName, updateType }: PackageRuleInputConfig,
+    { depName }: PackageRuleInputConfig,
     { matchDepPatterns }: PackageRule,
   ): boolean | null {
     if (is.undefined(matchDepPatterns)) {
@@ -18,37 +16,26 @@ export class DepPatternsMatcher extends Matcher {
       return false;
     }
 
-    let isMatch = false;
-    for (const packagePattern of matchDepPatterns) {
-      const packageRegex = regEx(massagePattern(packagePattern));
-      if (packageRegex.test(depName)) {
-        logger.trace(`${depName} matches against ${String(packageRegex)}`);
-        isMatch = true;
-      }
-    }
-    return isMatch;
+    const massagedPatterns = matchDepPatterns.map((pattern) =>
+      pattern === '^*$' || pattern === '*' ? '*' : `/${pattern}/`,
+    );
+    return matchRegexOrGlobList(depName, massagedPatterns);
   }
 
   override excludes(
-    { depName, updateType }: PackageRuleInputConfig,
+    { depName }: PackageRuleInputConfig,
     { excludeDepPatterns }: PackageRule,
   ): boolean | null {
-    // ignore lockFileMaintenance for backwards compatibility
     if (is.undefined(excludeDepPatterns)) {
       return null;
     }
     if (is.undefined(depName)) {
       return false;
     }
 
-    let isMatch = false;
-    for (const pattern of excludeDepPatterns) {
-      const packageRegex = regEx(massagePattern(pattern));
-      if (packageRegex.test(depName)) {
-        logger.trace(`${depName} matches against ${String(packageRegex)}`);
-        isMatch = true;
-      }
-    }
-    return isMatch;
+    const massagedPatterns = excludeDepPatterns.map((pattern) =>
+      pattern === '^*$' || pattern === '*' ? '*' : `/${pattern}/`,
+    );
+    return matchRegexOrGlobList(depName, massagedPatterns);
   }
 }

lib/util/package-rules/package-names.ts

@@ -1,5 +1,6 @@
 import is from '@sindresorhus/is';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
+import { matchRegexOrGlobList } from '../string-match';
 import { Matcher } from './base';
 
 export class PackageNameMatcher extends Matcher {
@@ -14,7 +15,7 @@ export class PackageNameMatcher extends Matcher {
     if (!packageName) {
       return false;
     }
-    return matchPackageNames.includes(packageName);
+    return matchRegexOrGlobList(packageName, matchPackageNames);
   }
 
   override excludes(
@@ -28,6 +29,6 @@ export class PackageNameMatcher extends Matcher {
     if (!packageName) {
       return false;
     }
-    return excludePackageNames.includes(packageName);
+    return matchRegexOrGlobList(packageName, excludePackageNames);
   }
 }

lib/util/package-rules/package-patterns.ts

@@ -1,22 +1,7 @@
 import is from '@sindresorhus/is';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
-import { logger } from '../../logger';
-import { regEx } from '../regex';
+import { matchRegexOrGlobList } from '../string-match';
 import { Matcher } from './base';
-import { massagePattern } from './utils';
-
-function matchPatternsAgainstName(
-  matchPackagePatterns: string[],
-  name: string,
-): boolean {
-  let isMatch = false;
-  for (const packagePattern of matchPackagePatterns) {
-    if (isPackagePatternMatch(packagePattern, name)) {
-      isMatch = true;
-    }
-  }
-  return isMatch;
-}
 
 export class PackagePatternsMatcher extends Matcher {
   override matches(
@@ -32,7 +17,10 @@ export class PackagePatternsMatcher extends Matcher {
       return false;
     }
 
-    return matchPatternsAgainstName(matchPackagePatterns, packageName);
+    const massagedPatterns = matchPackagePatterns.map((pattern) =>
+      pattern === '^*$' || pattern === '*' ? '*' : `/${pattern}/`,
+    );
+    return matchRegexOrGlobList(packageName, massagedPatterns);
   }
 
   override excludes(
@@ -48,15 +36,9 @@ export class PackagePatternsMatcher extends Matcher {
       return false;
     }
 
-    return matchPatternsAgainstName(excludePackagePatterns, packageName);
-  }
-}
-
-function isPackagePatternMatch(pckPattern: string, pck: string): boolean {
-  const re = regEx(massagePattern(pckPattern));
-  if (re.test(pck)) {
-    logger.trace(`${pck} matches against ${String(re)}`);
-    return true;
+    const massagedPatterns = excludePackagePatterns.map((pattern) =>
+      pattern === '^*$' || pattern === '*' ? '*' : `/${pattern}/`,
+    );
+    return matchRegexOrGlobList(packageName, massagedPatterns);
   }
-  return false;
 }

lib/util/package-rules/package-prefixes.ts

@@ -1,5 +1,6 @@
 import is from '@sindresorhus/is';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
+import { matchRegexOrGlobList } from '../string-match';
 import { Matcher } from './base';
 
 export class PackagePrefixesMatcher extends Matcher {
@@ -15,9 +16,10 @@ export class PackagePrefixesMatcher extends Matcher {
       return false;
     }
 
-    return matchPackagePrefixes.some((prefix) =>
-      packageName.startsWith(prefix),
+    const massagedPatterns = matchPackagePrefixes.map(
+      (pattern) => `${pattern}**`,
     );
+    return matchRegexOrGlobList(packageName, massagedPatterns);
   }
 
   override excludes(
@@ -32,8 +34,9 @@ export class PackagePrefixesMatcher extends Matcher {
       return false;
     }
 
-    return excludePackagePrefixes.some((prefix) =>
-      packageName.startsWith(prefix),
+    const massagedPatterns = excludePackagePrefixes.map(
+      (pattern) => `${pattern}**`,
     );
+    return matchRegexOrGlobList(packageName, massagedPatterns);
   }
 }

lib/util/package-rules/utils.ts

@@ -33,7 +33,3 @@ export function matcherOR(
   }
   return matchApplied ? false : null;
 }
-
-export function massagePattern(pattern: string): string {
-  return pattern === '^*$' || pattern === '*' ? '.*' : pattern;
-}