Skip to content

docs: add next development proposal to README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tomzen1 wants to merge 1 commit into from
Closed

docs: add next development proposal to README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,28 @@
$faker->text(20, 3, 10); // Sedev emeze evekem ez denebebekepep...

```

## Suggested next development

A high-impact next step would be introducing a provider-based architecture with locale dictionaries.

Why this is useful:
- easier to extend (e.g. company names, product names, job titles, UUIDs, IBAN, VAT IDs)
- locale support becomes clean and explicit (`en`, `hu`, `de`, etc.)
- avoids bloating the core `Faker` class with many domain-specific methods

Proposed API direction:

```php
$faker = Faker::init(['locale' => 'hu']);

$faker->person()->fullName();
$faker->company()->name();
$faker->internet()->email();
$faker->finance()->iban('HU');
```

Implementation notes:
- keep current methods for backward compatibility
- add providers incrementally (`PersonProvider`, `CompanyProvider`, `InternetProvider`, `FinanceProvider`)
- add deterministic generation via optional seed support for repeatable tests
Loading