fix: sanitize createRegExp return type (#180)

Author: didavid61202

src/core/types/escape.ts

@@ -20,7 +20,7 @@ export type EscapeChar<T extends string> = Escape<T, '\\' | '^' | '-' | ']'>
 export type StripEscapes<T extends string> = T extends `${infer A}\\${infer B}` ? `${A}${B}` : T
 
 // prettier-ignore
-type ExactEscapeChar = '.' | '*' | '+' | '?' | '^' | '$' | '{' | '}' | '(' | ')' | '|' | '[' | ']' | '/'
+export type ExactEscapeChar = '.' | '*' | '+' | '?' | '^' | '$' | '{' | '}' | '(' | ')' | '|' | '[' | ']' | '/'
 
 export type GetValue<T extends InputSource> = T extends string
   ? Escape<T, ExactEscapeChar>

src/index.ts

@@ -3,21 +3,31 @@ import { Input, exactly } from './core/inputs'
 import type { Join } from './core/types/join'
 import type { MagicRegExp, MagicRegExpMatchArray } from './core/types/magic-regexp'
 
-export const createRegExp = <
-  Value extends string,
-  NamedGroups extends string = never,
-  CapturedGroupsArr extends (string | undefined)[] = [],
-  Flags extends Flag[] = never[]
->(
-  raw: Input<Value, NamedGroups, CapturedGroupsArr> | Value,
-  flags?: [...Flags] | string | Set<Flag>
-) =>
-  new RegExp(exactly(raw).toString(), [...(flags || '')].join('')) as MagicRegExp<
-    `/${Value}/${Join<Flags, '', ''>}`,
-    NamedGroups,
-    CapturedGroupsArr,
+import type { Escape, ExactEscapeChar } from './core/types/escape'
+
+export const createRegExp: {
+  /** Create Magic RegExp from Input helper */
+  <
+    Value extends string,
+    NamedGroups extends string = never,
+    CapturedGroupsArr extends (string | undefined)[] = [],
+    Flags extends Flag[] = never[]
+  >(
+    raw: Input<Value, NamedGroups, CapturedGroupsArr>,
+    flags?: [...Flags] | string | Set<Flag>
+  ): MagicRegExp<`/${Value}/${Join<Flags, '', ''>}`, NamedGroups, CapturedGroupsArr, Flags[number]>
+  /** Create Magic RegExp from string, string will be sanitized */
+  <Value extends string, Flags extends Flag[] = never[]>(
+    raw: Value,
+    flags?: [...Flags] | string | Set<Flag>
+  ): MagicRegExp<
+    `/${Escape<Value, ExactEscapeChar>}/${Join<Flags, '', ''>}`,
+    never,
+    [],
     Flags[number]
   >
+} = (raw: any, flags?: any) =>
+  new RegExp(exactly(raw).toString(), [...(flags || '')].join('')) as any
 
 export * from './core/flags'
 export * from './core/inputs'

test/index.test.ts

@@ -26,7 +26,17 @@ describe('magic-regexp', () => {
   })
   it('collects flag type', () => {
     const re = createRegExp('.', [global, multiline])
-    expectTypeOf(re).toEqualTypeOf<MagicRegExp<'/./gm', never, [], 'g' | 'm'>>()
+    expectTypeOf(re).toEqualTypeOf<MagicRegExp<'/\\./gm', never, [], 'g' | 'm'>>()
+  })
+  it('sanitize string input', () => {
+    const escapeChars = '.*+?^${}()[]/'
+    const re = createRegExp(escapeChars)
+    expect(String(re)).toMatchInlineSnapshot(
+      '"/\\\\.\\\\*\\\\+\\\\?\\\\^\\\\$\\\\{\\\\}\\\\(\\\\)\\\\[\\\\]\\\\//"'
+    )
+    expectTypeOf(re).toEqualTypeOf<
+      MagicRegExp<'/\\.\\*\\+\\?\\^\\$\\{\\}\\(\\)\\[\\]\\//', never, []>
+    >()
   })
 })