refactor(locale): group name entries by gender

[xDivisionByZerox]

Description

Groups locale name entries in the PersonModule by gender.

Additional Info

Fixes #1677.

• Change file structure for gendered lists (names, prefixes etc) #1677

Script that was used to refactor locale files automatically

ℹ️ Note
The file being .ts is important, so you are able to directly import() other .ts files.

import { execSync } from 'node:child_process';
import { readdir, stat, unlink, writeFile } from 'node:fs/promises';
import { join, resolve } from 'node:path';

const localeRootDir = resolve('./src/locales');
const localeDirNames = await readdir(localeRootDir);

async function pathExist(path: string) {
  return stat(path)
    .then(() => true)
    .catch(() => false);
}

for (const localeDirName of localeDirNames) {
  const personPath = join(localeRootDir, localeDirName, 'person');
  if (!(await pathExist(personPath))) {
    continue;
  }

  const getEntryPath = (entryName: string) =>
    join(personPath, `${entryName}.ts`);

  const entryGroups = [
    ['prefix', 'female_prefix', 'male_prefix'],
    ['first_name', 'female_first_name', 'male_first_name'],
    ['middle_name', 'female_middle_name', 'male_middle_name'],
    ['last_name', 'female_last_name', 'male_last_name'],
    ['last_name_pattern', 'female_last_name_pattern', 'male_last_name_pattern'],
  ];
  for (const entryGroup of entryGroups) {
    const [mainEntry, femaleEntry, maleEntry] = entryGroup;
    const mainEntryPath = getEntryPath(mainEntry);
    const femaleEntryPath = getEntryPath(femaleEntry);
    const maleEntryPath = getEntryPath(maleEntry);

    const finalMainEntry: Record<string, unknown> = {};

    const keyPathMapList = [
      { key: 'generic', path: mainEntryPath },
      { key: 'female', path: femaleEntryPath },
      { key: 'male', path: maleEntryPath },
    ];
    for (const { key, path } of keyPathMapList) {
      if (!(await pathExist(path))) {
        continue;
      }

      const { default: defaultExportMember } = await import(`file://${path}`);
      if (!defaultExportMember) {
        continue;
      }

      finalMainEntry[key] = defaultExportMember;
    }

    // remove in second cycle in case files import each other
    for (const { path } of keyPathMapList) {
      await unlink(path).catch((): void => undefined);
    }

    if (Object.keys(finalMainEntry).length === 0) {
      continue;
    }

    await writeFile(
      mainEntryPath,
      `export default ${JSON.stringify(finalMainEntry)}`
    );
    execSync(`npx prettier --write ${mainEntryPath}`);
  }
}

Note

The script did not account for non-applicable values. These have been manually justified in 4b86dcb. A list of affected files can be found here.

[netlify]

✅ Deploy Preview for fakerjs ready!

Name	Link
🔨 Latest commit	3e2bb1b
🔍 Latest deploy log	https://app.netlify.com/sites/fakerjs/deploys/667f1694a52312000882d4fe
😎 Deploy Preview	https://deploy-preview-2938.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.95%. Comparing base (92a2f17) to head (3e2bb1b).

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2938      +/-   ##
==========================================
- Coverage   99.95%   99.95%   -0.01%     
==========================================
  Files        2984     2748     -236     
  Lines      216057   239091   +23034     
  Branches      597      586      -11     
==========================================
+ Hits       215969   238983   +23014     
- Misses         88      108      +20     

Files	Coverage Δ
src/index.ts	100.00% <100.00%> (ø)
src/locales/af_ZA/person/first_name.ts	100.00% <100.00%> (ø)
src/locales/af_ZA/person/index.ts	100.00% <ø> (ø)
src/locales/af_ZA/person/last_name.ts	100.00% <100.00%> (ø)
src/locales/af_ZA/person/last_name_pattern.ts	100.00% <100.00%> (ø)
src/locales/ar/location/street_pattern.ts	100.00% <100.00%> (ø)
src/locales/ar/person/first_name.ts	100.00% <100.00%> (ø)
src/locales/ar/person/index.ts	100.00% <ø> (ø)
src/locales/ar/person/last_name.ts	100.00% <100.00%> (ø)
src/locales/ar/person/last_name_pattern.ts	100.00% <100.00%> (ø)
... and 174 more

... and 264 files with indirect coverage changes

[Shinigami92]

I did not look into the 606 locales changes... The rest looks already really good to me, just some open questions about naming and wording

[ST-DDT]

Looks good to me, only the following things need to be discussed:

• Name of the helper type
• Location of the type definition
• Exact generic shape of the type

[ST-DDT]

Oh I'm sorry, looks like I caused a merged conflict 🙇‍♂️

[xDivisionByZerox]

Oh I'm sorry, looks like I caused a merged conflict 🙇‍♂️

All good, happens.I resolved them to the best of my abilities.