feat(i18n): convert to opaque keys

This commit is contained in:
Sam Potts
2026-07-16 16:54:37 +10:00
parent a9a09a7e52
commit 3cfcaa8530
203 changed files with 6522 additions and 4101 deletions
+83 -12
View File
@@ -1,7 +1,7 @@
import { mkdirSync, readdirSync, rmSync, unlinkSync, writeFileSync } from 'node:fs';
import { dirname, resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
import { fileURLToPath, pathToFileURL } from 'node:url';
import en from '../src/core/i18n/locales/en.ts';
import { LOCALES, localeAliases } from '../src/core/i18n/locales.ts';
const GENERATED_HEADER = '/** Generated by packages/core/scripts/generate-i18n-locales.ts — do not edit. */\n';
@@ -10,6 +10,7 @@ const coreRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..');
const coreLocalesDir = resolve(coreRoot, 'src/core/i18n/locales');
const htmlLocalesDir = resolve(coreRoot, '../html/src/i18n/locales');
const reactLocalesDir = resolve(coreRoot, '../react/src/i18n/locales');
const textDir = resolve(coreRoot, 'src/core/i18n/text');
const localeTags = [...LOCALES, ...localeAliases(LOCALES)] as const;
const PLATFORM_LOCALE_TAGS = ['en', ...localeTags] as const;
@@ -20,10 +21,7 @@ function importBinding(tag: string): string {
function objectEntry(tag: string): string {
const binding = importBinding(tag);
if (tag === binding) {
return ` ${tag},`;
}
return ` '${tag}': ${binding},`;
return tag === binding ? ` ${tag},` : ` '${tag}': ${binding},`;
}
function propertyKey(key: string): string {
@@ -35,20 +33,21 @@ function generateLoadLocaleTs(): string {
.map((tag) => ` ${propertyKey(tag.trim().replaceAll('_', '-').toLowerCase())}: () => import('./locales/${tag}'),`)
.join('\n');
return `${GENERATED_HEADER}import { findLocaleKeys, getCanonicalLocaleKey, hasRegisteredLocale } from './registry';
import type { Translations } from './types';
return `${GENERATED_HEADER}import { flattenTranslations } from './flatten';
import { findLocaleKeys, getCanonicalLocaleKey, hasRegisteredLocale } from './registry';
import type { FlatTranslations, Translations } from './types';
const loaders = {
${entries}
} as const satisfies Record<string, () => Promise<{ default: Partial<Translations> }>>;
} as const satisfies Record<string, () => Promise<{ default: Translations }>>;
/** Lazy-import a shipped locale pack when the tag is not already in the registry. */
export async function loadLocale(tag: string): Promise<Partial<Translations> | undefined> {
export async function loadLocale(tag: string): Promise<Partial<FlatTranslations> | undefined> {
if (hasRegisteredLocale(tag)) return undefined;
for (const chainTag of findLocaleKeys(tag)) {
if (hasRegisteredLocale(chainTag)) return undefined;
const load = loaders[getCanonicalLocaleKey(chainTag) as keyof typeof loaders];
if (load) return (await load()).default;
if (load) return flattenTranslations((await load()).default);
}
return undefined;
}
@@ -86,6 +85,76 @@ function generatePlatformAllReExport(): string {
`;
}
function exportName(key: string): string {
const name = key.slice(key.indexOf('.') + 1);
return name === 'default' ? 'defaultText' : name;
}
function stringLiteral(value: string): string {
return `'${value.replaceAll('\\', '\\\\').replaceAll("'", "\\'").replaceAll('\n', '\\n')}'`;
}
function generateTextModule(entries: [string, string][]): string {
const namespace = entries[0][0].slice(0, entries[0][0].indexOf('.'));
const prefix = `${namespace}.`;
const exports = entries
.map(
([key, text]) =>
`export const ${exportName(key)} = {\n key: \`\${prefix}${key.slice(prefix.length)}\`,\n text: ${stringLiteral(text)},\n} as const satisfies Text;`
)
.join('\n\n');
return `${GENERATED_HEADER}import type { Text } from '../text';\n\nconst prefix = '${prefix}';\n\n${exports}\n`;
}
function flattenEntries(value: Record<string, unknown>, prefix = ''): [string, string][] {
const entries: [string, string][] = [];
for (const [key, child] of Object.entries(value)) {
const fullKey = prefix ? `${prefix}.${key}` : key;
if (typeof child === 'string') {
entries.push([fullKey, child]);
} else {
entries.push(...flattenEntries(child as Record<string, unknown>, fullKey));
}
}
return entries;
}
async function validateLocaleCompleteness(): Promise<void> {
const englishKeys = new Set(flattenEntries(en).map(([key]) => key));
const errors: string[] = [];
for (const tag of localeTags) {
const { default: locale } = await import(pathToFileURL(resolve(coreLocalesDir, `${tag}.ts`)).href);
const localeKeys = new Set(flattenEntries(locale ?? {}).map(([key]) => key));
const missing = [...englishKeys].filter((key) => !localeKeys.has(key));
if (missing.length) errors.push(`${tag}: ${missing.join(', ')}`);
}
if (errors.length) {
throw new Error(`Locale packs are missing English keys:\n${errors.join('\n')}`);
}
}
function generateTextModules(): void {
rmSync(textDir, { recursive: true, force: true });
mkdirSync(textDir, { recursive: true });
const namespaces = new Map<string, [string, string][]>();
for (const [key, text] of flattenEntries(en)) {
const namespace = key.slice(0, key.indexOf('.'));
const entries = namespaces.get(namespace) ?? [];
entries.push([key, text]);
namespaces.set(namespace, entries);
}
for (const [namespace, entries] of namespaces) {
writeGenerated(resolve(textDir, `${namespace}.ts`), generateTextModule(entries));
}
}
function generatePlatformRegisterTs(tag: string): string {
return `${GENERATED_HEADER}import { registerI18n } from '@videojs/core/i18n';
import translations from '@videojs/core/i18n/locales/${tag}';
@@ -139,9 +208,11 @@ function syncPlatformLocaleDir(dir: string): void {
}
}
await validateLocaleCompleteness();
writeGenerated(resolve(coreLocalesDir, 'all.ts'), generateCoreAllTs());
writeGenerated(resolve(coreRoot, 'src/core/i18n/load-locale.ts'), generateLoadLocaleTs());
generateTextModules();
syncPlatformLocaleDir(htmlLocalesDir);
syncPlatformLocaleDir(reactLocalesDir);
console.log('[generate-i18n-locales] Updated core all.ts, load-locale.ts, and html/react locale re-exports');
console.log('[generate-i18n-locales] Updated locale packs, text descriptors, and platform re-exports');