Merge pull request #9 from a-tokyo/master

richardguerre · Feb 27, 2024 · 5e062a5 · 5e062a5
2 parents 48d53df + eee4685
commit 5e062a5
Show file tree

Hide file tree

Showing 7 changed files with 3,055 additions and 2,464 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .DS_Store
 node_modules
 dist
+.vscode
diff --git a/package.json b/package.json
@@ -50,25 +50,24 @@
   ],
   "devDependencies": {
     "@size-limit/preset-small-lib": "^5.0.1",
-    "@types/faker": "^5.5.6",
     "@types/react": "^17.0.13",
     "@types/relay-test-utils": "^6.0.4",
-    "@typescript-eslint/eslint-plugin": "^4.28.5",
-    "@typescript-eslint/parser": "^4.28.5",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
     "husky": "^7.0.0",
     "react": "^17.0.2",
     "react-relay": "^15.0.0",
     "relay-test-utils": "^15.0.0",
     "size-limit": "^5.0.1",
     "tsdx": "^0.14.1",
-    "tslib": "^2.3.0",
-    "typedoc": "^0.21.4",
-    "typedoc-plugin-markdown": "^3.10.4",
-    "typescript": "^4.3.5"
+    "tslib": "^2.6.2",
+    "typedoc": "^0.25.8",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "faker": "5.5.3",
-    "fuse.js": "6.4.6"
+    "@faker-js/faker": "^8.4.1",
+    "fuse.js": "^7.0.0"
   },
   "peerDependencies": {
     "react": ">16",

diff --git a/src/faker/types.ts b/src/faker/types.ts
@@ -20,11 +20,11 @@ export const fakerTypes = [
     keywords: ['random', 'alphaNumeric', 'random alphaNumeric'],
   },
   {
-    type: 'faker.name.firstName',
+    type: 'faker.person.firstName',
     keywords: ['firstName', 'given name', 'forename', 'name firstName'],
   },
   {
-    type: 'faker.name.lastName',
+    type: 'faker.person.lastName',
     keywords: [
       'lastName',
       'family name',
@@ -38,7 +38,7 @@ export const fakerTypes = [
     ],
   },
   {
-    type: 'faker.name.middleName',
+    type: 'faker.person.middleName',
     keywords: [
       'middleName',
       'given middle name',
@@ -47,31 +47,31 @@ export const fakerTypes = [
     ],
   },
   {
-    type: 'faker.name.findName',
+    type: 'faker.person.findName',
     keywords: ['fullName', 'name', 'findName', 'name findName'],
   },
   {
-    type: 'faker.name.jobTitle',
+    type: 'faker.person.jobTitle',
     keywords: ['name', 'jobTitle', 'name jobTitle'],
   },
   {
-    type: 'faker.name.gender',
+    type: 'faker.person.gender',
     keywords: ['name', 'gender', 'name gender'],
   },
   {
-    type: 'faker.name.prefix',
+    type: 'faker.person.prefix',
     keywords: ['name', 'prefix', 'name prefix'],
   },
   {
-    type: 'faker.name.suffix',
+    type: 'faker.person.suffix',
     keywords: ['name', 'suffix', 'name suffix'],
   },
   {
-    type: 'faker.name.title',
+    type: 'faker.person.title',
     keywords: ['name', 'title', 'name title'],
   },
   {
-    type: 'faker.name.jobDescriptor',
+    type: 'faker.person.jobDescriptor',
     keywords: [
       'name',
       'jobDescriptor',
@@ -82,7 +82,7 @@ export const fakerTypes = [
     ],
   },
   {
-    type: 'faker.name.jobArea',
+    type: 'faker.person.jobArea',
     keywords: [
       'name',
       'jobArea',
@@ -93,7 +93,7 @@ export const fakerTypes = [
     ],
   },
   {
-    type: 'faker.name.jobType',
+    type: 'faker.person.jobType',
     keywords: [
       'name',
       'jobType',
@@ -836,11 +836,11 @@ export const fakerTypes = [
     ],
   },
   {
-    type: 'faker.datatype.string',
+    type: 'faker.string.sample',
     keywords: ['datatype', 'string', 'datatype string', 'random string text'],
   },
   {
-    type: 'faker.datatype.uuid',
+    type: 'faker.string.uuid',
     keywords: ['datatype', 'uuid', 'datatype uuid'],
   },
   {
@@ -898,18 +898,18 @@ export type FakerPath =
   | 'faker.helpers.contextualCard'
   | 'faker.helpers.userCard'
   | 'faker.helpers.createTransaction'
-  | 'faker.name.firstName'
-  | 'faker.name.lastName'
-  | 'faker.name.middleName'
-  | 'faker.name.findName'
-  | 'faker.name.jobTitle'
-  | 'faker.name.gender'
-  | 'faker.name.prefix'
-  | 'faker.name.suffix'
-  | 'faker.name.title'
-  | 'faker.name.jobDescriptor'
-  | 'faker.name.jobArea'
-  | 'faker.name.jobType'
+  | 'faker.person.firstName'
+  | 'faker.person.lastName'
+  | 'faker.person.middleName'
+  | 'faker.person.findName'
+  | 'faker.person.jobTitle'
+  | 'faker.person.gender'
+  | 'faker.person.prefix'
+  | 'faker.person.suffix'
+  | 'faker.person.title'
+  | 'faker.person.jobDescriptor'
+  | 'faker.person.jobArea'
+  | 'faker.person.jobType'
   | 'faker.address.zipCode'
   | 'faker.address.zipCodeByState'
   | 'faker.address.city'
@@ -1107,8 +1107,8 @@ export type FakerPath =
   | 'faker.datatype.number'
   | 'faker.datatype.float'
   | 'faker.datatype.datetime'
-  | 'faker.datatype.string'
-  | 'faker.datatype.uuid'
+  | 'faker.string.sample'
+  | 'faker.string.uuid'
   | 'faker.datatype.boolean'
   | 'faker.datatype.hexaDecimal'
   | 'faker.datatype.json'

diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,6 @@
 import { useCallback, useEffect, useMemo } from 'react';
 import { createMockEnvironment } from 'relay-test-utils';
-import faker from 'faker';
+import { faker } from '@faker-js/faker';
 import Fuse from 'fuse.js';
 
 import {

diff --git a/src/utils.ts b/src/utils.ts
@@ -1,4 +1,4 @@
-import faker from 'faker';
+import { faker } from '@faker-js/faker';
 import { RelayMockOptions } from '.';
 
 export const runFakerUsingPath = (fakerPath: string) => {

diff --git a/tsconfig.json b/tsconfig.json
@@ -16,6 +16,7 @@
     // linter checks for common issues
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": false,
     // noUnused* overlap with @typescript-eslint/no-unused-vars, can disable if duplicative
     "noUnusedLocals": true,
     "noUnusedParameters": true,