Skip to content

fix: formatting and update examples in README #1817

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

Open
ferclager wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: formatting and update examples in README #1817

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22a019e
fix: formatting and update examples in README
ferclager May 15, 2026
c3e44b4
Fix Catalan language code in README
ferclager May 15, 2026
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
41 changes: 24 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,22 +163,22 @@ Schema<Name, String> fromScratch =
field("lastname", () -> faker.name().lastName()));
System.out.println(transformer.generate(fromScratch, 2));
// POSSIBLE OUTPUT
// "first_name" ; "last_name"
// "Kimberely" ; "Considine"
// "Mariela" ; "Krajcik"
// "firstName","lastname"
// "Kimberely","Considine"
// "Mariela","Krajcik"
// ----------------------
// Schema for transformations
Schema<Name, String> schemaForTransformations =
Schema.of(field("firstName", Name::firstName),
field("lastname", Name::lastName));
// Here we pass a collection of Name objects and extract first and lastnames from each element
// Here we pass a collection of Name objects and extract first and last names from each element
System.out.println(
transformer.generate(
faker.collection(faker::name).maxLen(2).generate(), schemaForTransformations));
// POSSIBLE OUTPUT
// "first_name" ; "last_name"
// "Kimberely" ; "Considine"
// "Mariela" ; "Krajcik"
// "firstName","lastname"
// "Kimberely","Considine"
// "Mariela","Krajcik"
```

#### JShell
Expand Down Expand Up @@ -208,7 +208,7 @@ jshell> Schema fromScratch =
fromScratch ==> net.datafaker.transformations.Schema@306a30c7

jshell> CsvTransformer<Name> transformer =
...> CsvTransformer.<Name>builder().header(false).separator(",").build();
...> CsvTransformer.<Name>builder().header(true).separator(",").build();
transformer ==> net.datafaker.transformations.CsvTransformer@506c589e

jshell> System.out.println(transformer.generate(fromScratch, 2));
Expand Down Expand Up @@ -439,21 +439,28 @@ The list below is not complete and shows only a part of available providers. To
* Slack Emoji
* Soul Knight
* Space
* StarCraft
* StarTrek
* Star Craft
* Star Trek
* Star Wars
* Stock
* Studio Ghibli
* Subscription
* Super Mario
* Superhero
* Tea
* Team
* The Expanse
* The IT Crowd
* The Kingkiller Chronicle
* The Matrix
* The Room
* The Thick Of It
* The Venture Bros
* Time
* Tormenta
* Touhou
* Tron
* Twin Peaks
* Tormenta
* Twitter
* University
* Vehicle
Expand All @@ -468,28 +475,28 @@ Usage with Locales
-----

```java
Faker faker = new Faker(new Locale("lang", "COUNTRY"));
Faker faker = new Faker(Locale.of("lang", "COUNTRY"));
```

For example:

```java
String californiaZipCode = new Faker(new Locale("en", "US")).address().zipCodeByState("CA");
String albanianIdNumber = new Faker(new Locale("sq", "AL")).idNumber().valid();
String moldovanPhone = new Faker(new Locale("ru", "MD")).phoneNumber().cellPhone();
String californiaZipCode = new Faker(Locale.of("en", "US")).address().zipCodeByState("CA");
String albanianIdNumber = new Faker(Locale.of("sq", "AL")).idNumber().valid();
String moldovanPhone = new Faker(Locale.of("ru", "MD")).phoneNumber().cellPhone();
```

Note that most of the data depends on language,
but some data depends purely on country (personal ID and phone numbers).
In the example above,
* "en", "sq", "ru" are language codes (English, Albanian and Russian), and
* "US", "AL", "MD" are country codes (USA, Albanian and Moldova)
* "US", "AL", "MD" are country codes (USA, Albania and Moldova)

<details>
<summary>Supported Locales</summary>

-----
* ar (Armenian)
* ar (Arabic)
* be_BY (Belarusian)
* bg_BG (Bulgarian)
* ca_CA (Canada)
Expand Down