Create reusable method for Regexp escaping members

webpro-nl · May 30, 2024 · 6531735 · 6531735
1 parent 8e2a4d3
commit 6531735
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/packages/knip/src/typescript/getImportsAndExports.ts b/packages/knip/src/typescript/getImportsAndExports.ts
@@ -13,6 +13,7 @@ import type {
   UnresolvedImport,
 } from '../types/serializable-map.js';
 import { timerify } from '../util/Performance.js';
+import { escapeRegexp } from '../util/escape-regexp.js';
 import { isStartsLikePackageName, sanitizeSpecifier } from '../util/modules.js';
 import { extname, isInNodeModules } from '../util/path.js';
 import { shouldIgnore } from '../util/tag.js';
@@ -400,7 +401,7 @@ const getImportsAndExports = (
   const setRefs = (item: SerializableExport | SerializableExportMember) => {
     if (!item.symbol) return;
     const symbols = new Set<ts.Symbol>();
-    for (const match of sourceFile.text.matchAll(new RegExp(item.identifier.replace(/[\\^$*+?.()|[\]{}]/g, '\\$&'), 'g'))) {
+    for (const match of sourceFile.text.matchAll(new RegExp(escapeRegexp(item.identifier)))) {
       const isDeclaration = match.index === item.pos || match.index === item.pos + 1; // off-by-one from `stripQuotes`
       if (!isDeclaration) {
         // @ts-expect-error ts.getTokenAtPosition is internal fn

diff --git a/packages/knip/src/util/escape-regexp.ts b/packages/knip/src/util/escape-regexp.ts
@@ -0,0 +1,8 @@
+/**
+ * Escapes a string to be used in a regular expression.
+ *
+ * Escapes all characters that have a special meaning in regular expressions.
+ */
+export function escapeRegexp(str: string): string {
+  return str.replace(/[\\^$*+?.()|[\]{}]/g, '\\$&');
+}