feat(package-rules)!: merge matchPaths and matchFiles into matchFileN…

…ames

Closes #22395

BREAKING CHANGE: matchPaths and matchFiles are now combined and merged into matchFileNames

docs/usage/configuration-options.md

@@ -1862,21 +1862,21 @@ For example, if you have an `examples` directory and you want all updates to tho
 {
   "packageRules": [
     {
-      "matchPaths": ["examples/**"],
+      "matchFileNames": ["examples/**"],
       "extends": [":semanticCommitTypeAll(chore)"]
     }
   ]
 }
 ```
 
-If you wish to limit Renovate to apply configuration rules to certain files in the root repository directory, you have to use `matchPaths` with a `minimatch` pattern or use [`matchFiles`](#matchfiles) with an exact match.
+If you wish to limit Renovate to apply configuration rules to certain files in the root repository directory, you have to use `matchFileNames` with a `minimatch` pattern (which can include an exact file name match).
 For example you have multiple `package.json` and want to use `dependencyDashboardApproval` only on the root `package.json`:
 
 ```json
 {
   "packageRules": [
     {
-      "matchFiles": ["package.json"],
+      "matchFileNames": ["package.json"],
       "dependencyDashboardApproval": true
     }
   ]
@@ -2171,23 +2171,50 @@ Use the syntax `!/ /` like this:
 }
 ```
 
-### matchFiles
+### matchFileNames
 
-Renovate will compare `matchFiles` for an exact match against the dependency's package file or lock file.
+Renovate will compare `matchFileNames` glob matching against the dependency's package file or lock file.
 
-For example the following would match `package.json` but not `package/frontend/package.json`:
+The following example would match `package.json` but not `package/frontend/package.json`:
 
 ```json
 {
   "packageRules": [
     {
-      "matchFiles": ["package.json"]
+      "matchFileNames": ["package.json"],
+      "labels": ["npm"]
     }
   ]
 }
 ```
 
-Use [`matchPaths`](#matchpaths) instead if you need more flexible matching.
+The following example matches any `package.json`, including files like `backend/package.json`:
+
+```json
+{
+  "packageRules": [
+    {
+      "description": "Group dependencies from package.json files",
+      "matchFileNames": ["**/package.json"],
+      "groupName": "All package.json changes"
+    }
+  ]
+}
+```
+
+The following example matches any file in directories starting with `app/`:
+
+```json
+{
+  "packageRules": [
+    {
+      "description": "Group all dependencies from the app directory",
+      "matchFileNames": ["app/**"],
+      "groupName": "App dependencies"
+    }
+  ]
+}
+```
 
 ### matchDepNames
 
@@ -2247,38 +2274,6 @@ See also `excludePackagePrefixes`.
 
 Just like the earlier `matchPackagePatterns` example, the above will configure `rangeStrategy` to `replace` for any package starting with `angular`.
 
-### matchPaths
-
-Renovate finds the file(s) listed in `matchPaths` with a `minimatch` glob pattern.
-
-For example the following matches any `package.json`, including files like `backend/package.json`:
-
-```json
-{
-  "packageRules": [
-    {
-      "description": "Group dependencies from package.json files",
-      "matchPaths": ["**/package.json"],
-      "groupName": "All package.json changes"
-    }
-  ]
-}
-```
-
-The following matches any file in directories starting with `app/`:
-
-```json
-{
-  "packageRules": [
-    {
-      "description": "Group all dependencies from the app directory",
-      "matchPaths": ["app/**"],
-      "groupName": "App dependencies"
-    }
-  ]
-}
-```
-
 ### matchSourceUrlPrefixes
 
 Here's an example of where you use this to group together all packages from the `renovatebot` GitHub org:

lib/config/__snapshots__/migration.spec.ts.snap

@@ -164,7 +164,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates config 1`
         "extends": [
           "node",
         ],
-        "matchPaths": [
+        "matchFileNames": [
           "node/**",
         ],
       },
@@ -211,7 +211,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates config 1`
       "extends": [
         "foo",
       ],
-      "matchPaths": [
+      "matchFileNames": [
         "examples/**",
       ],
     },
@@ -293,7 +293,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates more pack
       "matchDepTypes": [
         "devDependencies",
       ],
-      "matchPaths": [
+      "matchFileNames": [
         "package.json",
       ],
       "rangeStrategy": "pin",
@@ -302,7 +302,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates more pack
       "matchDepTypes": [
         "dependencies",
       ],
-      "matchPaths": [
+      "matchFileNames": [
         "package.json",
       ],
       "rangeStrategy": "pin",
@@ -332,13 +332,13 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates packageFi
   ],
   "packageRules": [
     {
-      "matchPaths": [
+      "matchFileNames": [
         "backend/package.json",
       ],
       "rangeStrategy": "replace",
     },
     {
-      "matchPaths": [
+      "matchFileNames": [
         "frontend/package.json",
       ],
       "rangeStrategy": "pin",
@@ -347,7 +347,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates packageFi
       "matchDepTypes": [
         "devDependencies",
       ],
-      "matchPaths": [
+      "matchFileNames": [
         "other/package.json",
       ],
       "rangeStrategy": "pin",
@@ -356,7 +356,7 @@ exports[`config/migration migrateConfig(config, parentConfig) migrates packageFi
       "matchDepTypes": [
         "dependencies",
       ],
-      "matchPaths": [
+      "matchFileNames": [
         "other/package.json",
       ],
       "rangeStrategy": "pin",

lib/config/migration.spec.ts

@@ -568,7 +568,7 @@ describe('config/migration', () => {
             matchManagers: ['dockerfile'],
             matchPackageNames: ['foo'],
             matchPackagePatterns: ['^bar'],
-            matchPaths: ['package.json'],
+            matchFileNames: ['package.json'],
             matchSourceUrlPrefixes: ['https://github.com/lodash'],
             matchUpdateTypes: ['major'],
           },

lib/config/migrations/custom/automerge-major-migration.spec.ts

@@ -19,13 +19,13 @@ describe('config/migrations/custom/automerge-major-migration', () => {
       {
         automergeMajor: 'some-value',
         major: {
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       },
       {
         major: {
           automerge: true,
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       }
     );

lib/config/migrations/custom/automerge-minor-migration.spec.ts

@@ -19,13 +19,13 @@ describe('config/migrations/custom/automerge-minor-migration', () => {
       {
         automergeMinor: 'some-value',
         minor: {
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       },
       {
         minor: {
           automerge: true,
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       }
     );

lib/config/migrations/custom/automerge-patch-migration.spec.ts

@@ -19,13 +19,13 @@ describe('config/migrations/custom/automerge-patch-migration', () => {
       {
         automergePatch: 'some-value',
         patch: {
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       },
       {
         patch: {
           automerge: true,
-          matchFiles: ['test'],
+          matchFileNames: ['test'],
         },
       }
     );

lib/config/migrations/custom/package-rules-migration.spec.ts

@@ -48,7 +48,7 @@ describe('config/migrations/custom/package-rules-migration', () => {
       {
         packageRules: [
           {
-            matchPaths: [],
+            matchFileNames: [],
             packgageRules: {
               languages: ['javascript'],
             },

lib/config/migrations/custom/package-rules-migration.ts

@@ -2,7 +2,9 @@ import type { PackageRule } from '../../types';
 import { AbstractMigration } from '../base/abstract-migration';
 
 export const renameMap = {
-  paths: 'matchPaths',
+  matchFiles: 'matchFileNames',
+  matchPaths: 'matchFileNames',
+  paths: 'matchFileNames',
   languages: 'matchLanguages',
   baseBranchList: 'matchBaseBranches',
   managers: 'matchManagers',

lib/config/options/index.ts

@@ -1294,20 +1294,9 @@ const options: RenovateOptions[] = [
     env: false,
   },
   {
-    name: 'matchFiles',
+    name: 'matchFileNames',
     description:
-      'List of strings to do an exact match against package files with full path. Only works inside a `packageRules` object.',
-    type: 'array',
-    subType: 'string',
-    stage: 'repository',
-    parent: 'packageRules',
-    cli: false,
-    env: false,
-  },
-  {
-    name: 'matchPaths',
-    description:
-      'List of glob patterns to match against package files. Only works inside a `packageRules` object.',
+      'List of glob patterns to match against package or lock files (with full repo path). Only works inside a `packageRules` object.',
     type: 'array',
     subType: 'string',
     stage: 'repository',

lib/config/presets/internal/default.ts

@@ -361,7 +361,7 @@ export const presets: Record<string, Preset> = {
       'Use semanticCommitType `{{arg0}}` for all package files matching path `{{arg1}}`.',
     packageRules: [
       {
-        matchPaths: ['{{arg0}}'],
+        matchFileNames: ['{{arg0}}'],
         semanticCommitType: '{{arg1}}',
       },
     ],

lib/config/types.ts

@@ -313,8 +313,7 @@ export interface PackageRule
     Record<string, unknown> {
   description?: string | string[];
   isVulnerabilityAlert?: boolean;
-  matchFiles?: string[];
-  matchPaths?: string[];
+  matchFileNames?: string[];
   matchLanguages?: string[];
   matchBaseBranches?: string[];
   matchManagers?: string | string[];
@@ -459,6 +458,7 @@ export type RenovateOptions =
 export interface PackageRuleInputConfig extends Record<string, unknown> {
   versioning?: string;
   packageFile?: string;
+  lockFiles?: string[];
   depType?: string;
   depTypes?: string[];
   depName?: string;

lib/config/validation.ts

@@ -311,8 +311,7 @@ export async function validateConfig(
             }
 
             const selectors = [
-              'matchFiles',
-              'matchPaths',
+              'matchFileNames',
               'matchLanguages',
               'matchBaseBranches',
               'matchManagers',

lib/modules/manager/npm/extract/index.ts

@@ -64,7 +64,7 @@ export async function extractPackageFile(
     const error = new Error(CONFIG_VALIDATION);
     error.validationSource = fileName;
     error.validationError =
-      'Nested package.json must not contain renovate configuration. Please use `packageRules` with `matchPaths` in your main config instead.';
+      'Nested package.json must not contain renovate configuration. Please use `packageRules` with `matchFileNames` in your main config instead.';
     throw error;
   }
   const packageJsonName = packageJson.name;

lib/util/package-rules/files.spec.ts

@@ -1,7 +1,7 @@
-import { FilesMatcher } from './files';
+import { FileNamesMatcher } from './files';
 
 describe('util/package-rules/files', () => {
-  const fileMatcher = new FilesMatcher();
+  const fileMatcher = new FileNamesMatcher();
 
   describe('match', () => {
     it('should return false if packageFile is not defined', () => {
@@ -10,7 +10,7 @@ describe('util/package-rules/files', () => {
           packageFile: undefined,
         },
         {
-          matchFiles: ['frontend/package.json'],
+          matchFileNames: ['frontend/package.json'],
         }
       );
       expect(result).toBeFalse();

lib/util/package-rules/files.ts

@@ -1,23 +1,27 @@
 import is from '@sindresorhus/is';
+import { minimatch } from 'minimatch';
 import type { PackageRule, PackageRuleInputConfig } from '../../config/types';
 import { Matcher } from './base';
 
-export class FilesMatcher extends Matcher {
+export class FileNamesMatcher extends Matcher {
   override matches(
     { packageFile, lockFiles }: PackageRuleInputConfig,
-    { matchFiles }: PackageRule
+    { matchFileNames }: PackageRule
   ): boolean | null {
-    if (is.undefined(matchFiles)) {
+    if (is.undefined(matchFileNames)) {
       return null;
     }
     if (is.undefined(packageFile)) {
       return false;
     }
 
-    return matchFiles.some(
-      (fileName) =>
-        packageFile === fileName ||
-        (is.array(lockFiles) && lockFiles?.includes(fileName))
+    return matchFileNames.some(
+      (matchFileName) =>
+        minimatch(packageFile, matchFileName, { dot: true }) ||
+        (is.array(lockFiles) &&
+          lockFiles.some((lockFile) =>
+            minimatch(lockFile, matchFileName, { dot: true })
+          ))
     );
   }
 }