From 22a019e1df25a5de7a64dbd4928f7888a246ac99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fernando=20Ram=C3=ADrez=20Clager?= <17533449+ferclager@users.noreply.github.com> Date: Fri, 15 May 2026 18:12:42 +0200 Subject: [PATCH 1/2] fix: formatting and update examples in README Updated README to correct formatting and clarify examples. --- README.md | 45 ++++++++++++++++++++++++++------------------- 1 file changed, 26 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 996d01dc0..dc17a2d34 100644 --- a/README.md +++ b/README.md @@ -163,22 +163,22 @@ Schema 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 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 @@ -208,7 +208,7 @@ jshell> Schema fromScratch = fromScratch ==> net.datafaker.transformations.Schema@306a30c7 jshell> CsvTransformer transformer = - ...> CsvTransformer.builder().header(false).separator(",").build(); + ...> CsvTransformer.builder().header(true).separator(",").build(); transformer ==> net.datafaker.transformations.CsvTransformer@506c589e jshell> System.out.println(transformer.generate(fromScratch, 2)); @@ -439,8 +439,9 @@ 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 @@ -448,12 +449,18 @@ The list below is not complete and shows only a part of available providers. To * 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 @@ -468,32 +475,32 @@ 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)
Supported Locales ----- -* ar (Armenian) +* ar (Arabic) * be_BY (Belarusian) * bg_BG (Bulgarian) -* ca_CA (Canada) -* ca-CAT +* ca (Catalan) +* ca-CAT (language: Catalan, country: Catalonia) * cs_CZ (Czech republic) * da-DK (language: Danish, country: Denmark) * de (German) From c3e44b469a9301979e196939d563573f809ba4ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fernando=20Ram=C3=ADrez=20Clager?= <17533449+ferclager@users.noreply.github.com> Date: Fri, 15 May 2026 18:25:34 +0200 Subject: [PATCH 2/2] Fix Catalan language code in README undo 2 locations --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc17a2d34..f356d4dfd 100644 --- a/README.md +++ b/README.md @@ -499,8 +499,8 @@ In the example above, * ar (Arabic) * be_BY (Belarusian) * bg_BG (Bulgarian) -* ca (Catalan) -* ca-CAT (language: Catalan, country: Catalonia) +* ca_CA (Canada) +* ca-CAT * cs_CZ (Czech republic) * da-DK (language: Danish, country: Denmark) * de (German)