test(date): Add Intl-Based Tests for Date Definitions to Ensure Completeness of Weekdays and Months

scripts/generate-locales.ts

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
 
+/* eslint-disable no-restricted-globals */
+
 /**
  * This file contains a script that can be used to update the following files:
  *
  * - `src/locale/<locale>.ts`
+ * - `src/locales/<locale>/date/month.ts`
+ * - `src/locales/<locale>/date/weekday.ts`
  * - `src/locales/<locale>/index.ts`
  * - `src/locales/<locale>/<module...>/index.ts`
  * - `src/docs/guide/localization.md`
@@ -15,10 +19,21 @@
  * Run this script using `pnpm run generate:locales`
  */
 import { constants } from 'node:fs';
-import { access, readFile, readdir, stat, writeFile } from 'node:fs/promises';
+import {
+ access,
+ mkdir,
+ readFile,
+ readdir,
+ stat,
+ writeFile,
+} from 'node:fs/promises';
 import { dirname, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import type { LocaleDefinition, MetadataDefinition } from '../src/definitions';
+import type {
+ DateEntryDefinition,
+ LocaleDefinition,
+ MetadataDefinition,
+} from '../src/definitions';
 import { keys } from '../src/internal/keys';
 import { formatMarkdown, formatTypescript } from './apidocs/utils/format';
 
@@ -111,6 +126,41 @@ function escapeField(parent: string, module: string): string {
  return module;
 }
 
+function isValidLocale(locale: string): boolean {
+ // 'dv' (Dhivehi) locale is excluded because it may not be fully supported
+ if (locale === 'dv') return false;
+ try {
+ new Intl.DateTimeFormat(locale);
+ return true;
+ } catch {
+ return false;
+ }
+}
+
+function normalizeDataRecursive<T>(localeData: T): T {
+ if (typeof localeData !== 'object' || localeData === null) {
+ // we can only traverse object-like structs
+ return localeData;
+ }
+
+ if (Array.isArray(localeData)) {
+ return (
+ [...new Set(localeData)]
+ // limit entries to 1k
+ .slice(0, 1000)
+ // sort entries alphabetically
+ .sort() as T
+ );
+ }
+
+ const result = {} as T;
+ for (const key of keys(localeData)) {
+ result[key] = normalizeDataRecursive(localeData[key]);
+ }
+
+ return result;
+}
+
 async function generateLocaleFile(locale: string): Promise<void> {
  const parts = locale.split('_');
  const locales = [locale];
@@ -286,30 +336,6 @@ async function updateLocaleFileHook(
  * @param definitionKey The definition key of the current file (ex. 'location').
  */
 async function normalizeLocaleFile(filePath: string, definitionKey: string) {
- function normalizeDataRecursive<T>(localeData: T): T {
- if (typeof localeData !== 'object' || localeData === null) {
- // we can only traverse object-like structs
- return localeData;
- }
-
- if (Array.isArray(localeData)) {
- return (
- [...new Set(localeData)]
- // limit entries to 1k
- .slice(0, 1000)
- // sort entries alphabetically
- .sort() as T
- );
- }
-
- const result = {} as T;
- for (const key of keys(localeData)) {
- result[key] = normalizeDataRecursive(localeData[key]);
- }
-
- return result;
- }
-
  const legacyDefinitions = ['app', 'cell_phone', 'team'];
  const definitionsToSkip = [
  'finance',
@@ -368,6 +394,145 @@ async function normalizeLocaleFile(filePath: string, definitionKey: string) {
  return writeFile(filePath, await formatTypescript(newContent));
 }
 
+// `src/locales/<locale>/date/*
+async function generateDateModule(locale: string) {
+ if (!isValidLocale(locale)) return;
+
+ const pathDate = resolve(pathLocales, locale, 'date');
+
+ // Function to check if it has the same data as the parent locale
+ async function isParentLocaleSame(
+ locale: string,
+ fileName: string
+ ): Promise<boolean> {
+ const parentLocale = locale.split('_').slice(0, -1).join('_');
+ if (!parentLocale) return false;
+
+ const parentFilePath = resolve(pathLocales, parentLocale, 'date', fileName);
+ const currentFilePath = resolve(pathDate, fileName);
+
+ try {
+ const [parentFileContent, currentFileContent] = await Promise.all([
+ readFile(parentFilePath, 'utf8'),
+ readFile(currentFilePath, 'utf8'),
+ ]);
+
+ return parentFileContent === currentFileContent;
+ } catch {
+ return false;
+ }
+ }
+
+ // `src/locales/<locale>/date/weekday.ts`
+ async function generateWeekdayFile(): Promise<void> {
+ const weekdayPath = resolve(pathDate, 'weekday.ts');
+ let storedWeekdays: Partial<DateEntryDefinition> = {};
+
+ // Skip creation if it has the same data as the parent locale
+ if (await isParentLocaleSame(locale, 'weekday.ts')) {
+ console.log(
+ `Skipping weekday file generation for locale ${locale} as it is identical to its parent.`
+ );
+ return;
+ }
+
+ // Import the current weekday values
+ try {
+ const imported = await import(`file:${weekdayPath}`);
+ storedWeekdays = imported.default;
+ } catch {
+ console.log(`Creating weekday.ts file for locale ${locale}.`);
+ }
+
+ // Generate correct weekday values
+ const wide: string[] = [];
+ const abbr: string[] = [];
+ const intlWeekdayLong = new Intl.DateTimeFormat(
+ locale.replaceAll('_', '-'),
+ {
+ weekday: 'long',
+ }
+ );
+ const intlWeekdayShort = new Intl.DateTimeFormat(
+ locale.replaceAll('_', '-'),
+ {
+ weekday: 'short',
+ }
+ );
+ for (let i = 0; i < 7; i++) {
+ const date: Date = new Date(2020, 0, i + 4);
+ // January 4-10, 2020 are Sunday to Saturday
+ wide.push(intlWeekdayLong.format(date));
+ abbr.push(intlWeekdayShort.format(date));
+ }
+
+ storedWeekdays.wide = wide;
+ storedWeekdays.abbr = abbr;
+
+ // Write updated values back to the file
+ const normalizedWeekdays = normalizeDataRecursive(storedWeekdays);
+ const updatedContent = `
+ ${autoGeneratedCommentHeader}
+ export default ${JSON.stringify(normalizedWeekdays, null, 2)};
+ `;
+ return writeFile(weekdayPath, await formatTypescript(updatedContent));
+ }
+
+ // `src/locales/<locale>/date/month.ts`
+ async function generateMonthFile(): Promise<void> {
+ const monthPath = resolve(pathDate, 'month.ts');
+ let storedMonths: Partial<DateEntryDefinition> = {};
+
+ // Skip creation if it has the same data as the parent locale
+ if (await isParentLocaleSame(locale, 'month.ts')) {
+ console.log(
+ `Skipping month file generation for locale ${locale} as it is identical to its parent.`
+ );
+ return;
+ }
+
+ // Import the current month values
+ try {
+ const imported = await import(`file:${monthPath}`);
+ storedMonths = imported.default;
+ } catch {
+ console.log(`Creating month.ts file for locale ${locale}.`);
+ }
+
+ // Generate correct month values
+ const wide: string[] = [];
+ const abbr: string[] = [];
+ const intlMonthLong = new Intl.DateTimeFormat(locale.replaceAll('_', '-'), {
+ month: 'long',
+ });
+ const intlMonthShort = new Intl.DateTimeFormat(
+ locale.replaceAll('_', '-'),
+ { month: 'short' }
+ );
+ for (let i = 0; i < 12; i++) {
+ const date: Date = new Date(2020, i, 1);
+ wide.push(intlMonthLong.format(date));
+ abbr.push(intlMonthShort.format(date));
+ }
+
+ storedMonths.wide = wide;
+ storedMonths.abbr = abbr;
+
+ // Write updated values back to the file
+ const normalizedMonths = normalizeDataRecursive(storedMonths);
+ const updatedContent = `
+ ${autoGeneratedCommentHeader}
+ export default ${JSON.stringify(normalizedMonths, null, 2)};
+ `;
+ return writeFile(monthPath, await formatTypescript(updatedContent));
+ }
+
+ await mkdir(pathDate, { recursive: true });
+ await generateWeekdayFile();
+ await generateMonthFile();
+ return generateRecursiveModuleIndexes(pathDate, locale, 'DateDefinition', 2);
+}
+
 // Start of actual logic
 
 const locales = await readdir(pathLocales);
@@ -411,6 +576,9 @@ for (const locale of locales) {
  localesIndexImports += `import { default as ${locale} } from './${locale}';\n`;
  localizationLocales += `| \`${locale}\` | ${localeTitle} | \`${localizedFaker}\` |\n`;
 
+ // We first need to generate the date module
+ await generateDateModule(locale);
+
  promises.push(
  // src/locale/<locale>.ts
  // eslint-disable-next-line unicorn/prefer-top-level-await -- Disabled for performance

src/locales/ar/date/month.ts

@@ -1,22 +1,26 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
 export default {
  wide: [
- 'آب',
- 'آذَار',
- 'أَيَّار',
- 'أَيْلُول',
- 'تَمُّوز',
- 'تِشْرِين ٱلثَّانِي',
- 'تِشْرِين ٱلْأَوَّل',
- 'حَزِيرَان',
- 'شُبَاط',
- 'كَانُون ٱلثَّانِي',
- 'كَانُون ٱلْأَوَّل',
- 'نَيْسَان',
+ 'أبريل',
+ 'أغسطس',
+ 'أكتوبر',
+ 'ديسمبر',
+ 'سبتمبر',
+ 'فبراير',
+ 'مارس',
+ 'مايو',
+ 'نوفمبر',
+ 'يناير',
+ 'يوليو',
+ 'يونيو',
  ],
  abbr: [
+ 'أبريل',
  'أغسطس',
  'أكتوبر',
- 'إبريل',
  'ديسمبر',
  'سبتمبر',
  'فبراير',

src/locales/ar/date/weekday.ts

@@ -1,9 +1,21 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
 export default {
- abbr: null,
+ abbr: [
+ 'الأحد',
+ 'الأربعاء',
+ 'الاثنين',
+ 'الثلاثاء',
+ 'الجمعة',
+ 'الخميس',
+ 'السبت',
+ ],
  wide: [
- 'الأحَد',
+ 'الأحد',
  'الأربعاء',
- 'الإثنين',
+ 'الاثنين',
  'الثلاثاء',
  'الجمعة',
  'الخميس',

src/locales/az/date/month.ts

@@ -1,3 +1,7 @@
+/*
+ * This file is automatically generated.
+ * Run 'pnpm run generate:locales' to update.
+ */
 export default {
  wide: [
  'aprel',
@@ -28,18 +32,18 @@ export default {
  'января',
  ],
  abbr: [
- 'авг.',
- 'апр.',
- 'дек.',
- 'июль',
- 'июнь',
- 'май',
- 'март',
- 'нояб.',
- 'окт.',
- 'сент.',
- 'февр.',
- 'янв.',
+ 'apr',
+ 'avq',
+ 'dek',
+ 'fev',
+ 'iyl',
+ 'iyn',
+ 'mar',
+ 'may',
+ 'noy',
+ 'okt',
+ 'sen',
+ 'yan',
  ],
  abbr_context: [
  'авг.',