feat(mock): add schemasImportPath to faker generator

[aqeelat]

Summary

Adds a schemasImportPath option to the faker mock generator so consumers can point schema-level faker factories at a dedicated barrel separate from the production type barrel (schemas.importPath).

When schemas.importPath resolves to a single barrel file (e.g. via tsconfig path mappings like "@acme/models": ["libs/models/public-api.ts"]), appending /index.faker produces an unresolvable sub-path — a barrel specifier isn't a directory prefix. schemasImportPath is used verbatim as the schema factory import path, sidestepping that limitation.

Resolves #3612.

output: {
  schemas: { path: './libs/models', importPath: '@acme/models' },
  mock: {
    generators: [
      { type: 'faker', schemas: true, schemasImportPath: '@acme/models/fakers' },
    ],
  },
}

// Before (default — joins importPath with /index.faker, may not resolve):
import { getPetMock } from '@acme/models/index.faker';
// After (schemasImportPath used verbatim):
import { getPetMock } from '@acme/models/fakers';

Changes

• packages/core/src/types.ts — Add schemasImportPath?: string to FakerMockOptions.
• packages/core/src/writers/generate-imports-for-builder.ts — When the faker generator has schemas: true and schemasImportPath set, use it verbatim as the schema factory dependency instead of joining importPath with index.faker.
• packages/orval/src/utils/options.ts — Extract a shared validatePackageSpecifier helper (reused by schemas.importPath) and validate schemasImportPath: reject empty/whitespace/relative/absolute specifiers; require both schemas: true and schemas.importPath.
• Tests — generate-imports-for-builder.test.ts (+2), options.test.ts (+6 incl. a describe block for the new validation).
• Docs — Faker generator table updated (added schemas, schemasImportPath, operationResponses, arrayItems rows) plus a schemasImportPath example section.

Checklist

• Tests pass (generate-imports-for-builder.test.ts, options.test.ts)
• Typecheck passes (core, orval, mock)
• Lint passes (0 warnings, 0 errors)
• Format passes

Summary by CodeRabbit

Release Notes

• New Features

  • Added schemasImportPath configuration option for faker generators, enabling users to specify a custom import path for schema-level faker factories instead of using the default /index.faker pattern.

• Documentation

  • Updated configuration documentation to clarify export requirements and explain the new schemasImportPath override option for faker mock generators.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a3d6b5cc-bb87-49ae-be34-75324e6456fa

📥 Commits

Reviewing files that changed from the base of the PR and between 66af3e2 and 6e1e0cb.

📒 Files selected for processing (6)

• docs/content/docs/reference/configuration/output.mdx
• packages/core/src/types.ts
• packages/core/src/writers/generate-imports-for-builder.test.ts
• packages/core/src/writers/generate-imports-for-builder.ts
• packages/orval/src/utils/options.test.ts
• packages/orval/src/utils/options.ts

---

📝 Walkthrough

Walkthrough

Adds a schemasImportPath option to the faker mock generator configuration that overrides the import path for schema-level faker factory functions. Validation is refactored into a reusable validatePackageSpecifier helper, cross-field constraints are enforced in normalizeOptions, import path computation in generateImportsForBuilder is updated to use the new field verbatim, and corresponding tests and documentation are added.

Changes

faker schemasImportPath option

Layer / File(s)	Summary
FakerMockOptions type contract packages/core/src/types.ts	Adds the optional schemasImportPath?: string field to FakerMockOptions with JSDoc describing its relationship to schemas.importPath.
Package specifier validation and cross-field constraints packages/orval/src/utils/options.ts	Refactors schemas.importPath checks into a reusable validatePackageSpecifier() helper. During normalizeOptions, validates schemasImportPath as a valid specifier on faker generators and enforces that schemas: true and schemas.importPath are both set when schemasImportPath is provided.
schemaFactory import path computation packages/core/src/writers/generate-imports-for-builder.ts	Adds getFakerSchemasImportPath helper that reads schemasImportPath from normalized faker generator config. Updates generateImportsForBuilder to use that value verbatim as schemaFactoryDependency, falling back to the relative index.faker path.
Validation and import-generation tests packages/orval/src/utils/options.test.ts, packages/core/src/writers/generate-imports-for-builder.test.ts	Updates error message assertions for existing schemas.importPath tests; adds a faker schemasImportPath validation block covering invalid specifiers, missing schemas.importPath, missing schemas: true, and a passing acceptance case; adds two new import-builder cases for verbatim and fallback dependency resolution.
Documentation docs/content/docs/reference/configuration/output.mdx	Extends output.schemas.importPath requirements to note the ./index.faker sub-path export constraint and adds a schemasImportPath subsection to the faker generator options table with before/after import examples.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related issues

• Faker schema factory import path doesn't resolve when schemas.importPath is set #3612: This PR directly implements the schemasImportPath option proposed in that issue, resolving the unresolvable import path problem caused by appending index.faker to a barrel-resolved package specifier.

Possibly related PRs

• orval-labs/orval#3548: Modifies the same generate-imports-for-builder.ts schemaFactory import/dependency path computation, specifically for output.schemas.importPath, which this PR extends for the faker-specific case.

Suggested labels

mock, enhancement

Suggested reviewers

• wadakatu
• melloware

Poem

🐇 Hopping through the barrel paths so long,
index.faker tacked on — something felt wrong.
Now schemasImportPath sets the specifier free,
Verbatim and tidy, just as it should be.
Validated with guards both cross-field and tight,
This rabbit's mock imports finally compile right! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically summarizes the main change: adding a schemasImportPath option to the faker generator, which is the primary feature introduced across all modified files.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}