@kubb/plugin-faker 5.1.4 → 5.1.6

package/docs/options.md

@@ -117,7 +117,7 @@ Library used to generate strings that satisfy a regex `pattern` in the spec.
 ::field-group
 
 :::field{name="'faker'"}
-Default value. Generates `faker.helpers.fromRegExp(pattern)` without an extra dependency.
+Default value. Generates `faker.helpers.fromRegExp(/pattern/)` without an extra dependency. Faker does not support shorthand classes such as `\d`, `\w`, or `\s`, so use `'randexp'` for patterns that contain them.
 :::
 
 :::field{name="'randexp'"}

package/docs/overview.md

@@ -1,24 +1,29 @@
 # Faker
 
-Generates a Faker.js mock-data factory for every schema in your OpenAPI spec. Use the factories in tests, Storybook, and local development without a running backend. Each factory accepts partial data that overrides the generated values.
+The Faker plugin generates one factory function per schema. Each factory returns mock data from Faker.js and accepts partial data that overrides the generated values.
 
-`@kubb/plugin-msw` can use these factories to fill mock responses.
+Use the factories in tests, Storybook, and local development without a running backend. `@kubb/plugin-msw` can use them to fill mock responses.
 
 ## Setup
 
-- Add `@kubb/plugin-ts` for the factory return types.
-- Install `@faker-js/faker` v9 or higher in the app that uses the generated code.
+- Add `@kubb/plugin-ts` for the factory return types. Generation fails without it.
+- Install `@faker-js/faker` v10 in the app that uses the generated code.
+- Install `dayjs`, `moment`, or `randexp` when you pick it in `dateParser` or `regexGenerator`.
 
 ## Options worth knowing
 
 - `seed` passes a fixed seed to `faker.seed(...)`, so every run returns the same data.
 - `locale` sets the Faker locale. The default is `en`.
-- `dateParser` formats date and time strings with `faker` (default), `dayjs`, or `moment`. Install the library you pick.
+- `dateParser` formats `date` and `time` strings with `faker` (default), `dayjs`, or `moment`. `date-time` values always use Faker. `dayjs` and `moment` do not work when the adapter types a date or time as `Date`, for example with `dateType: 'date'`.
 - `regexGenerator` turns a `pattern` into a string with `faker` (default) or `randexp`.
-- `typeMode` sets the factory types: `inferred` (default) derives them from the generated values. `schema` uses the declared model type.
+- `typeMode` sets the factory types: `inferred` (default) derives them from the generated values, and `schema` uses the declared model type.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/plugin-faker/options) for every option and its default.
 
 ## Example
 
+The config below generates the factories with a fixed seed.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { pluginTs } from '@kubb/plugin-ts'
@@ -33,9 +38,3 @@ export default defineConfig({
   ],
 })
 ```
-
-## See also
-
-- [Faker.js](https://fakerjs.dev/)
-- [@kubb/plugin-ts](https://kubb.dev/extensions/kubb-labs/plugin-ts)
-- [@kubb/plugin-msw](https://kubb.dev/extensions/kubb-labs/plugin-msw)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-faker",
-  "version": "5.1.4",
+  "version": "5.1.6",
   "description": "Generate Faker.js mock data factories with Kubb. Produces realistic seed data and fixtures for development and testing.",
   "keywords": [
     "code-generation",
@@ -74,17 +74,17 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.9"
+    "@kubb/plugin-ts": "^5.0.11"
   },
   "devDependencies": {
     "@faker-js/faker": "^10.6.0",
     "@internals/shared": "0.0.0",
     "@internals/utils": "0.0.0",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2"
   },
   "peerDependencies": {
     "@faker-js/faker": "^10.0.0",
-    "kubb": "^5.8.3"
+    "kubb": "^5.9.2"
   },
   "peerDependenciesMeta": {
     "@faker-js/faker": {