fix: correct use of regex

kubb-labs · Mar 8, 2024 · 405e6f1 · 405e6f1
1 parent df5da5a
commit 405e6f1
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 2 deletions.
diff --git a/.changeset/tricky-plants-rush.md b/.changeset/tricky-plants-rush.md
@@ -0,0 +1,5 @@
+---
+"@kubb/swagger-faker": patch
+---
+
+correct use of regex for faker
diff --git a/examples/faker/petStore.yaml b/examples/faker/petStore.yaml
@@ -671,7 +671,7 @@ components:
               description: Description
             - enum:
                 - "NW"
-                - "NE" 
+                - "NE"
                 - "SW"
                 - "SE"
               description: Wind direction
@@ -719,6 +719,9 @@ components:
           description: User Status
           format: int32
           example: 1
+        nationalityCode:
+          type: string
+          pattern: "^[A-Z]{2}$"
       xml:
         name: user
     Tag:

diff --git a/examples/faker/src/gen/customMocks/createUser.ts b/examples/faker/src/gen/customMocks/createUser.ts
@@ -12,6 +12,7 @@ export function createUser(override: NonNullable<Partial<User>> = {}): NonNullab
       'password': faker.internet.password(),
       'phone': faker.phone.number(),
       'userStatus': faker.number.float({}),
+      'nationalityCode': faker.helpers.fromRegExp(/^[A-Z]{2}$/),
     },
     ...override,
   }

diff --git a/examples/faker/src/gen/index.ts b/examples/faker/src/gen/index.ts
@@ -1,2 +1,2 @@
-export * from './customMocks/index'
 export * from './models/index'
+export * from './customMocks/index'
diff --git a/examples/faker/src/gen/models/User.ts b/examples/faker/src/gen/models/User.ts
@@ -40,4 +40,8 @@ export type User = {
    * @example 1
    */
   userStatus?: number
+  /**
+   * @type string | undefined
+   */
+  nationalityCode?: string
 }
diff --git a/packages/swagger-faker/src/fakerParser.test.ts b/packages/swagger-faker/src/fakerParser.test.ts
@@ -45,6 +45,13 @@ const input = [
     }),
     expected: 'faker.helpers.fromRegExp("*")',
   },
+  {
+    input: parseFakerMeta({
+      keyword: 'matches',
+      args: '^[A-Z]{2}$',
+    }),
+    expected: 'faker.helpers.fromRegExp(/^[A-Z]{2}$/)',
+  },
   {
     input: parseFakerMeta({
       keyword: 'ref',

diff --git a/packages/swagger-faker/src/fakerParser.ts b/packages/swagger-faker/src/fakerParser.ts
@@ -192,6 +192,18 @@ export function parseFakerMeta(
     return value
   }
 
+  if (isKeyword(item, fakerKeywords.matches)) {
+    const options = (item as FakerMetaBase<unknown>).args as string
+    let regex
+    try {
+      regex = new RegExp(options)
+    } catch (_e) {
+      regex = JSON.stringify(options)
+    }
+
+    return `${value}(${regex ?? ''})`
+  }
+
   if (item.keyword in mapper) {
     const options = JSON.stringify((item as FakerMetaBase<unknown>).args)
     return `${value}(${options ?? ''})`