From 558b959e0e2f791dab0ba2f500493ba7ddbd25e2 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 25 May 2024 21:45:31 +0200 Subject: refactor(locale)!: use snake case for all locale data (#2910) --- docs/guide/upgrading.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'docs/guide') diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md index 1981c501..653570b6 100644 --- a/docs/guide/upgrading.md +++ b/docs/guide/upgrading.md @@ -480,6 +480,28 @@ Renamed deprecated locale aliases `cz`, `en_IND`, `ge` and removed `global`. | `import { faker } from '@faker-js/faker/locale/ge'` | `import { faker } from '@faker-js/faker/locale/ka_GE'` | | `import { faker } from '@faker-js/faker/locale/global'` | `import { faker } from '@faker-js/faker/locale/base'` | +### Renamed Locale Definitions + +The following locale definitions have been renamed + +| old | replacement | +| ------------------------------------------- | -------------------------------------------- | +| `faker.definitions.science.chemicalElement` | `faker.definitions.science.chemical_element` | +| `faker.definitions.system.directoryPaths` | `faker.definitions.system.directory_paths` | +| `faker.definitions.system.mimeTypes` | `faker.definitions.system.mime_types` | + +With that now all our locale data use the following naming scheme: + +```txt +faker.definitions.category_name.entry_name +``` + +Please keep in mind that property keys of complex objects remain in camel-case. + +```txt +faker.definitions.science.chemical_element.atomicNumber +``` + ### Type Aliases Removed deprecated type aliases -- cgit v1.2.3