feat(pluginutils): add suffixRegex & support multiple string (#1886)

btea · web-flow · commit 917d710f4bfd · 2025-09-04T09:37:35.000-04:00
* feat(pluginutils): add `suffixRegex` &amp; support multiple string

* chore: update
diff --git a/packages/pluginutils/README.md b/packages/pluginutils/README.md
@@ -227,7 +227,7 @@ export default function myPlugin(options = {}) {
 
 Constructs a RegExp that matches the exact string specified. This is useful for plugin hook filters.
 
-Parameters: `(str: String, flags?: String)`<br>
+Parameters: `(str: String | Array[...String], flags?: String)`<br>
 Returns: `RegExp`
 
 #### Usage
@@ -236,6 +236,7 @@ Returns: `RegExp`
 import { exactRegex } from '@rollup/pluginutils';
 
 exactRegex('foobar'); // /^foobar$/
+exactRegex(['foo', 'bar']); // /^(?:foo|bar)$/
 exactRegex('foo(bar)', 'i'); // /^foo\(bar\)$/i
 ```
 
@@ -275,7 +276,7 @@ normalizePath('foo/bar'); // 'foo/bar'
 
 Constructs a RegExp that matches a value that has the specified prefix. This is useful for plugin hook filters.
 
-Parameters: `(str: String, flags?: String)`<br>
+Parameters: `(str: String | Array[...String], flags?: String)`<br>
 Returns: `RegExp`
 
 #### Usage
@@ -284,9 +285,27 @@ Returns: `RegExp`
 import { prefixRegex } from '@rollup/pluginutils';
 
 prefixRegex('foobar'); // /^foobar/
+prefixRegex(['foo', 'bar']); // /^(?:foo|bar)/
 prefixRegex('foo(bar)', 'i'); // /^foo\(bar\)/i
 ```
 
+### suffixRegex
+
+Constructs a RegExp that matches a value that has the specified suffix. This is useful for plugin hook filters.
+
+Parameters: `(str: String | Array[...String], flags?: String)`<br>
+Returns: `RegExp`
+
+#### Usage
+
+```js
+import { suffixRegex } from '@rollup/pluginutils';
+
+suffixRegex('foobar'); // /foobar$/
+suffixRegex(['foo', 'bar']); // /(?:foo|bar)$/
+suffixRegex('foo(bar)', 'i'); // /foo\(bar\)$/i
+```
+
 ## Meta
 
 [CONTRIBUTING](/.github/CONTRIBUTING.md)
diff --git a/packages/pluginutils/src/filterUtils.ts b/packages/pluginutils/src/filterUtils.ts
@@ -1,12 +1,26 @@
-export function exactRegex(str: string, flags?: string): RegExp {
-  return new RegExp(`^${escapeRegex(str)}$`, flags);
+export function exactRegex(str: string | string[], flags?: string): RegExp {
+  return new RegExp(`^${combineMultipleStrings(str)}$`, flags);
 }
 
-export function prefixRegex(str: string, flags?: string): RegExp {
-  return new RegExp(`^${escapeRegex(str)}`, flags);
+export function prefixRegex(str: string | string[], flags?: string): RegExp {
+  return new RegExp(`^${combineMultipleStrings(str)}`, flags);
+}
+
+export function suffixRegex(str: string | string[], flags?: string): RegExp {
+  return new RegExp(`${combineMultipleStrings(str)}$`, flags);
 }
 
 const escapeRegexRE = /[-/\\^$*+?.()|[\]{}]/g;
 function escapeRegex(str: string): string {
   return str.replace(escapeRegexRE, '\\$&');
 }
+function combineMultipleStrings(str: string | string[]): string {
+  if (Array.isArray(str)) {
+    const escapeStr = str.map(escapeRegex).join('|');
+    if (escapeStr && str.length > 1) {
+      return `(?:${escapeStr})`;
+    }
+    return escapeStr;
+  }
+  return escapeRegex(str);
+}
diff --git a/packages/pluginutils/src/index.ts b/packages/pluginutils/src/index.ts
@@ -5,7 +5,7 @@ import dataToEsm from './dataToEsm';
 import extractAssignedNames from './extractAssignedNames';
 import makeLegalIdentifier from './makeLegalIdentifier';
 import normalizePath from './normalizePath';
-import { exactRegex, prefixRegex } from './filterUtils';
+import { exactRegex, prefixRegex, suffixRegex } from './filterUtils';
 
 export {
   addExtension,
@@ -16,7 +16,8 @@ export {
   extractAssignedNames,
   makeLegalIdentifier,
   normalizePath,
-  prefixRegex
+  prefixRegex,
+  suffixRegex
 };
 
 // TODO: remove this in next major
@@ -29,5 +30,6 @@ export default {
   extractAssignedNames,
   makeLegalIdentifier,
   normalizePath,
-  prefixRegex
+  prefixRegex,
+  suffixRegex
 };
diff --git a/packages/pluginutils/test/filterUtils.ts b/packages/pluginutils/test/filterUtils.ts
@@ -1,27 +1,75 @@
 import test from 'ava';
 
-import { exactRegex, prefixRegex } from '../';
+import { exactRegex, prefixRegex, suffixRegex } from '../';
 
 test('exactRegex supports without flag parameter', (t) => {
   t.is(exactRegex('foo').toString(), '/^foo$/');
 });
 
+test('exactRegex supports with multiple string and without flag parameter', (t) => {
+  t.is(exactRegex(['foo', 'bar']).toString(), '/^(?:foo|bar)$/');
+});
+
 test('exactRegex supports with flag parameter', (t) => {
   t.is(exactRegex('foo', 'i').toString(), '/^foo$/i');
 });
 
+test('exactRegex supports with multiple string and flag parameter', (t) => {
+  t.is(exactRegex(['foo', 'bar'], 'i').toString(), '/^(?:foo|bar)$/i');
+});
+
 test('exactRegex escapes special characters for Regex', (t) => {
   t.is(exactRegex('foo(bar)').toString(), '/^foo\\(bar\\)$/');
 });
 
+test('exactRegex escapes special characters with multiple string for Regex', (t) => {
+  t.is(exactRegex(['foo(bar)', 'baz(qux)']).toString(), '/^(?:foo\\(bar\\)|baz\\(qux\\))$/');
+});
+
 test('prefixRegex supports without flag parameter', (t) => {
   t.is(prefixRegex('foo').toString(), '/^foo/');
 });
 
+test('prefixRegex supports with multiple string and without flag parameter', (t) => {
+  t.is(prefixRegex(['foo', 'bar']).toString(), '/^(?:foo|bar)/');
+});
+
 test('prefixRegex supports with flag parameter', (t) => {
   t.is(prefixRegex('foo', 'i').toString(), '/^foo/i');
 });
 
+test('prefixRegex supports with multiple string and flag parameter', (t) => {
+  t.is(prefixRegex(['foo', 'bar'], 'i').toString(), '/^(?:foo|bar)/i');
+});
+
 test('prefixRegex escapes special characters for Regex', (t) => {
   t.is(prefixRegex('foo(bar)').toString(), '/^foo\\(bar\\)/');
 });
+
+test('prefixRegex escapes special characters with multiple string for Regex', (t) => {
+  t.is(prefixRegex(['foo(bar)', 'baz(qux)']).toString(), '/^(?:foo\\(bar\\)|baz\\(qux\\))/');
+});
+
+test('suffixRegex supports without flag parameter', (t) => {
+  t.is(suffixRegex('foo').toString(), '/foo$/');
+});
+
+test('suffixRegex supports with multiple string and without flag parameter', (t) => {
+  t.is(suffixRegex(['foo', 'bar']).toString(), '/(?:foo|bar)$/');
+});
+
+test('suffixRegex supports with flag parameter', (t) => {
+  t.is(suffixRegex('foo', 'i').toString(), '/foo$/i');
+});
+
+test('suffixRegex supports with multiple string and flag parameter', (t) => {
+  t.is(suffixRegex(['foo', 'bar'], 'i').toString(), '/(?:foo|bar)$/i');
+});
+
+test('suffixRegex escapes special characters for Regex', (t) => {
+  t.is(suffixRegex('foo(bar)').toString(), '/foo\\(bar\\)$/');
+});
+
+test('suffixRegex escapes special characters with multiple string for Regex', (t) => {
+  t.is(suffixRegex(['foo(bar)', 'baz(qux)']).toString(), '/(?:foo\\(bar\\)|baz\\(qux\\))$/');
+});
diff --git a/packages/pluginutils/types/index.d.ts b/packages/pluginutils/types/index.d.ts
@@ -67,7 +67,7 @@ export function dataToEsm(data: unknown, options?: DataToEsmOptions): string;
  * @param str the string to match.
  * @param flags flags for the RegExp.
  */
-export function exactRegex(str: string, flags?: string): RegExp;
+export function exactRegex(str: string | string[], flags?: string): RegExp;
 
 /**
  * Extracts the names of all assignment targets based upon specified patterns.
@@ -90,7 +90,14 @@ export function normalizePath(filename: string): string;
  * @param str the string to match.
  * @param flags flags for the RegExp.
  */
-export function prefixRegex(str: string, flags?: string): RegExp;
+export function prefixRegex(str: string | string[], flags?: string): RegExp;
+
+/**
+ * Constructs a RegExp that matches a value that has the specified suffix.
+ * @param str the string to match.
+ * @param flags flags for the RegExp.
+ */
+export function suffixRegex(str: string | string[], flags?: string): RegExp;
 
 export type AddExtension = typeof addExtension;
 export type AttachScopes = typeof attachScopes;
@@ -101,6 +108,7 @@ export type MakeLegalIdentifier = typeof makeLegalIdentifier;
 export type NormalizePath = typeof normalizePath;
 export type DataToEsm = typeof dataToEsm;
 export type PrefixRegex = typeof prefixRegex;
+export type SuffixRegex = typeof suffixRegex;
 
 declare const defaultExport: {
   addExtension: AddExtension;
@@ -112,5 +120,6 @@ declare const defaultExport: {
   makeLegalIdentifier: MakeLegalIdentifier;
   normalizePath: NormalizePath;
   prefixRegex: PrefixRegex;
+  suffixRegex: SuffixRegex;
 };
 export default defaultExport;
