@kubb/plugin-faker 5.1.1 → 5.1.3

package/OVERVIEW.md

@@ -0,0 +1,18 @@
+# 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.
+
+`@kubb/plugin-msw` can use these factories 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.
+
+## 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.
+- `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.

package/dist/index.cjs

@@ -1497,6 +1497,15 @@ const fakerGenerator = (0, kubb_kit.defineGenerator)({
 	}
 });
 //#endregion
+//#region kubb-extension.json
+var compatibility = {
+	"kubb": ">=5.8.0",
+	"node": ">=22"
+};
+//#endregion
+//#region package.json
+var version = "5.1.3";
+//#endregion
 //#region src/resolvers/resolverFaker.ts
 /**
 * Default resolver used by `@kubb/plugin-faker`. Decides the names and file
@@ -1550,36 +1559,35 @@ const pluginFakerName = "plugin-faker";
 * })
 * ```
 */
-const pluginFaker = (0, kubb_kit.definePlugin)((options) => {
-	const { output = {
-		path: "mocks",
-		barrel: { type: "named" }
-	}, seed, locale = "en", group, exclude = [], include, override = [], typeMode = "inferred", dateParser = "faker", regexGenerator = "faker", printer, resolver: userResolver, macros: userMacros } = options;
-	const groupConfig = createGroupConfig(group);
-	return {
+const pluginFaker = (0, kubb_kit.definePlugin)({
+	meta: {
 		name: pluginFakerName,
-		options,
-		dependencies: [_kubb_plugin_ts.pluginTsName],
-		hooks: { "kubb:plugin:setup"(ctx) {
-			ctx.requirePlugin(_kubb_plugin_ts.pluginTsName);
-			ctx.setOptions({
-				output,
-				seed,
-				locale,
-				exclude,
-				include,
-				override,
-				typeMode,
-				group: groupConfig,
-				dateParser,
-				regexGenerator,
-				printer
-			});
-			ctx.setResolver(userResolver ? kubb_kit.Resolver.merge(resolverFaker, userResolver) : resolverFaker);
-			if (userMacros?.length) ctx.setMacros(userMacros);
-			ctx.addGenerator(fakerGenerator);
-		} }
-	};
+		version,
+		compatibility
+	},
+	dependencies: { [_kubb_plugin_ts.pluginTsName]: {} },
+	setup(options) {
+		const { output = {
+			path: "mocks",
+			barrel: { type: "named" }
+		}, seed, locale = "en", group, exclude = [], include, override = [], typeMode = "inferred", dateParser = "faker", regexGenerator = "faker", printer, resolver: userResolver, macros: userMacros } = options;
+		(0, kubb_kit.setResolver)(userResolver ? kubb_kit.Resolver.merge(resolverFaker, userResolver) : resolverFaker);
+		if (userMacros?.length) (0, kubb_kit.setMacros)(userMacros);
+		(0, kubb_kit.addGenerator)(fakerGenerator);
+		return {
+			output,
+			seed,
+			locale,
+			exclude,
+			include,
+			override,
+			typeMode,
+			group: createGroupConfig(group),
+			dateParser,
+			regexGenerator,
+			printer
+		};
+	}
 });
 //#endregion
 exports.Faker = Faker;