refactor: Support glob patterns (via minimatch) rather than regular expressions

Author: Josmithr

apps/api-extractor/package.json

@@ -45,6 +45,7 @@
     "@rushstack/ts-command-line": "workspace:*",
     "colors": "~1.2.1",
     "lodash": "~4.17.15",
+    "minimatch": "~3.0.3",
     "resolve": "~1.22.1",
     "semver": "~7.5.4",
     "source-map": "~0.6.1",
@@ -56,6 +57,7 @@
     "@rushstack/heft-node-rig": "2.4.0",
     "@types/heft-jest": "1.0.1",
     "@types/lodash": "4.14.116",
+    "@types/minimatch": "3.0.5",
     "@types/node": "18.17.15",
     "@types/resolve": "1.20.2",
     "@types/semver": "7.5.0"

apps/api-extractor/src/api/ExtractorConfig.ts

@@ -837,7 +837,8 @@ export class ExtractorConfig {
       }
 
       const bundledPackages: string[] = configObject.bundledPackages || [];
-      // Note: we cannot fully validate package name pattern, as the string may be a RegExp pattern.
+
+      // Note: we cannot fully validate package name patterns, as the strings may contain wildcards.
       // We won't know if the entries are valid until we can compare them against the package.json "dependencies" contents.
 
       const tsconfigFilePath: string = ExtractorConfig._resolvePathWithTokens(

apps/api-extractor/src/api/IConfigFile.ts

@@ -376,7 +376,8 @@ export interface IConfigFile {
 
   /**
    * A list of NPM package names whose exports should be treated as part of this package.
-   * Supports regular expressions.
+   *
+   * @remarks Also supports glob patterns.
    *
    * @example
    *

apps/api-extractor/src/collector/Collector.ts

@@ -11,6 +11,7 @@ import {
   PackageName
 } from '@rushstack/node-core-library';
 import { ReleaseTag } from '@microsoft/api-extractor-model';
+import minimatch from 'minimatch';
 
 import { ExtractorMessageId } from '../api/ExtractorMessageId';
 
@@ -157,56 +158,57 @@ export class Collector {
   }
 
   /**
-   * Searches the provided package.json for dependencies that match the provided package names and/or RegExp patterns
+   * Searches the provided package.json for dependencies that match the provided package names and/or glob patterns
    * in `bundledPackages`.
-   * @param bundledPackages - The list of package names and/or RegExp patterns to search for in the package.json.
+   * @param bundledPackages - The list of package names and/or glob patterns to search for in the package.json.
    * @param packageJson - The package.json of the package being processed.
    * @returns The set of matching package names.
    */
   private static _resolveBundledPackagePatterns(
     bundledPackages: string[],
     packageJson: INodePackageJson | undefined
   ): ReadonlySet<string> {
-    // The set to be built up and returned
-    const packageNames: Set<string> = new Set<string>();
-
     if (bundledPackages.length === 0) {
       // If no `bundledPackages` were specified, then there is nothing to resolve.
       // Return an empty set.
-      return packageNames;
+      return new Set<string>();
     }
 
     if (packageJson === undefined) {
       // If no package.json is present, then there are no possible package matches.
       // Return an empty set.
-      return packageNames;
+      return new Set<string>();
     }
 
     const dependencyNames: string[] = Object.keys(packageJson.dependencies ?? {});
 
     if (dependencyNames.length === 0) {
       // If there are no dependencies, then there are no possible package matches.
       // Return an empty set.
-      return packageNames;
+      return new Set<string>();
     }
 
+    // The set of resolved package names to be populated and returned
+    const packageNames: Set<string> = new Set<string>();
+
     for (const packageNameOrPattern of bundledPackages) {
       // If the string is an exact package name, search for exact match
       if (PackageName.isValidName(packageNameOrPattern)) {
         if (dependencyNames.includes(packageNameOrPattern)) {
           packageNames.add(packageNameOrPattern);
         }
       } else {
-        // If the entry isn't an exact package name, assume RegExp and search for matches
-        const regexp: RegExp = new RegExp(packageNameOrPattern);
-        const matches: string[] = dependencyNames.filter((dependencyName) => regexp.test(dependencyName));
+        // If the entry isn't an exact package name, assume glob pattern and search for matches
+        const matches: string[] = dependencyNames.filter((dependencyName) =>
+          minimatch(dependencyName, packageNameOrPattern)
+        );
         matches.forEach((match) => packageNames.add(match));
       }
     }
     return packageNames;
   }
 
-  /**
+  /**a
    * Returns a list of names (e.g. "example-library") that should appear in a reference like this:
    *
    * ```

apps/api-extractor/src/schemas/api-extractor.schema.json

@@ -24,7 +24,7 @@
     },
 
     "bundledPackages": {
-      "description": "A list of NPM package names whose exports should be treated as part of this package. Also supports regular expressions.",
+      "description": "A list of NPM package names whose exports should be treated as part of this package. Also supports glob patterns.",
       "type": "array",
       "items": {
         "type": "string"

build-tests/api-extractor-scenarios/src/bundledPackages/config/api-extractor-overrides.json

@@ -1,3 +1,3 @@
 {
-  "bundledPackages": ["api-extractor-lib1-test", "api-extractor-lib2.*"]
+  "bundledPackages": ["api-extractor-lib1-test", "api-extractor-lib2*"]
 }