fix(i18n): consolidate locale definitions

Author: dante01yoon

src/i18n.test.ts

@@ -1,6 +1,19 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest'
-const { i18n, loadLocale, mergeCustomNodesI18n, resolveSupportedLocale } =
-  await import('./i18n')
+
+import type * as I18nModule from './i18n'
+
+let i18n: typeof I18nModule.i18n
+let loadLocale: typeof I18nModule.loadLocale
+let mergeCustomNodesI18n: typeof I18nModule.mergeCustomNodesI18n
+let resolveSupportedLocale: typeof I18nModule.resolveSupportedLocale
+
+async function importI18nModule() {
+  const i18nModule = await import('./i18n')
+  i18n = i18nModule.i18n
+  loadLocale = i18nModule.loadLocale
+  mergeCustomNodesI18n = i18nModule.mergeCustomNodesI18n
+  resolveSupportedLocale = i18nModule.resolveSupportedLocale
+}
 
 // Mock the JSON imports before importing i18n module
 vi.mock('./locales/en/main.json', () => ({ default: { welcome: 'Welcome' } }))
@@ -25,6 +38,7 @@ vi.mock('./locales/zh/settings.json', () => ({ default: { theme: '主题' } }))
 describe('i18n', () => {
   beforeEach(async () => {
     vi.resetModules()
+    await importI18nModule()
   })
 
   describe('mergeCustomNodesI18n', () => {
@@ -47,8 +61,6 @@ describe('i18n', () => {
     })
 
     it('should store data for not-yet-loaded locales', async () => {
-      const { i18n, mergeCustomNodesI18n } = await import('./i18n')
-
       // Chinese is not pre-loaded, data should be stored but not merged yet
       mergeCustomNodesI18n({
         zh: {
@@ -149,7 +161,7 @@ describe('i18n', () => {
     it('should handle calling mergeCustomNodesI18n multiple times', async () => {
       // Use fresh module instance to ensure clean state
       vi.resetModules()
-      const { i18n, loadLocale, mergeCustomNodesI18n } = await import('./i18n')
+      await importI18nModule()
 
       mergeCustomNodesI18n({
         zh: { plugin1: { name: '插件1' } }
@@ -190,12 +202,19 @@ describe('i18n', () => {
       expect(resolved).toBe('zh-TW')
     })
 
-    it('should fall back from pt-BR base tag pt to pt-BR', async () => {
-      // pt is not shipped on its own, but pt-BR is.
-      // resolveSupportedLocale only fires the base-tag fallback for inputs
-      // whose full tag isn't shipped — verifying the standalone helper here.
-      expect(resolveSupportedLocale('pt-BR')).toBe('pt-BR')
-      expect(resolveSupportedLocale('pt')).toBe('en')
+    it('should preserve shipped pt-BR locale through loadLocale', async () => {
+      const resolved = await loadLocale('pt-BR')
+
+      expect(resolved).toBe('pt-BR')
+      expect(i18n.global.getLocaleMessage('pt-BR')).toEqual(
+        expect.objectContaining({
+          commands: expect.any(Object),
+          nodeDefs: expect.any(Object),
+          settings: expect.any(Object)
+        })
+      )
+
+      expect(await loadLocale('pt')).toBe('en')
     })
 
     it('should handle concurrent load requests for same locale', async () => {

src/i18n.ts

@@ -1,14 +1,19 @@
 import { createI18n } from 'vue-i18n'
 
-// ESLint cannot statically resolve dynamic imports with relative paths in template strings,
-// but these are valid ES module imports that Vite processes correctly at build time.
+import {
+  localeDefinitions,
+  resolveSupportedLocale
+} from '@/locales/localeConfig'
+import type { SupportedLocale } from '@/locales/localeConfig'
 
 // Import only English locale eagerly as the default/fallback
 import enCommands from './locales/en/commands.json' with { type: 'json' }
 import en from './locales/en/main.json' with { type: 'json' }
 import enNodes from './locales/en/nodeDefs.json' with { type: 'json' }
 import enSettings from './locales/en/settings.json' with { type: 'json' }
 
+export { resolveSupportedLocale }
+
 function buildLocale<
   M extends Record<string, unknown>,
   N extends Record<string, unknown>,
@@ -23,75 +28,6 @@ function buildLocale<
   } as M & { nodeDefs: N; commands: C; settings: S }
 }
 
-// Locale loader map - dynamically import locales only when needed
-const localeLoaders: Record<
-  string,
-  () => Promise<{ default: Record<string, unknown> }>
-> = {
-  ar: () => import('./locales/ar/main.json'),
-  es: () => import('./locales/es/main.json'),
-  fa: () => import('./locales/fa/main.json'),
-  fr: () => import('./locales/fr/main.json'),
-  ja: () => import('./locales/ja/main.json'),
-  ko: () => import('./locales/ko/main.json'),
-  ru: () => import('./locales/ru/main.json'),
-  tr: () => import('./locales/tr/main.json'),
-  zh: () => import('./locales/zh/main.json'),
-  'zh-TW': () => import('./locales/zh-TW/main.json'),
-  'pt-BR': () => import('./locales/pt-BR/main.json')
-}
-
-const nodeDefsLoaders: Record<
-  string,
-  () => Promise<{ default: Record<string, unknown> }>
-> = {
-  ar: () => import('./locales/ar/nodeDefs.json'),
-  es: () => import('./locales/es/nodeDefs.json'),
-  fa: () => import('./locales/fa/nodeDefs.json'),
-  fr: () => import('./locales/fr/nodeDefs.json'),
-  ja: () => import('./locales/ja/nodeDefs.json'),
-  ko: () => import('./locales/ko/nodeDefs.json'),
-  ru: () => import('./locales/ru/nodeDefs.json'),
-  tr: () => import('./locales/tr/nodeDefs.json'),
-  zh: () => import('./locales/zh/nodeDefs.json'),
-  'zh-TW': () => import('./locales/zh-TW/nodeDefs.json'),
-  'pt-BR': () => import('./locales/pt-BR/nodeDefs.json')
-}
-
-const commandsLoaders: Record<
-  string,
-  () => Promise<{ default: Record<string, unknown> }>
-> = {
-  ar: () => import('./locales/ar/commands.json'),
-  es: () => import('./locales/es/commands.json'),
-  fa: () => import('./locales/fa/commands.json'),
-  fr: () => import('./locales/fr/commands.json'),
-  ja: () => import('./locales/ja/commands.json'),
-  ko: () => import('./locales/ko/commands.json'),
-  ru: () => import('./locales/ru/commands.json'),
-  tr: () => import('./locales/tr/commands.json'),
-  zh: () => import('./locales/zh/commands.json'),
-  'zh-TW': () => import('./locales/zh-TW/commands.json'),
-  'pt-BR': () => import('./locales/pt-BR/commands.json')
-}
-
-const settingsLoaders: Record<
-  string,
-  () => Promise<{ default: Record<string, unknown> }>
-> = {
-  ar: () => import('./locales/ar/settings.json'),
-  es: () => import('./locales/es/settings.json'),
-  fa: () => import('./locales/fa/settings.json'),
-  fr: () => import('./locales/fr/settings.json'),
-  ja: () => import('./locales/ja/settings.json'),
-  ko: () => import('./locales/ko/settings.json'),
-  ru: () => import('./locales/ru/settings.json'),
-  tr: () => import('./locales/tr/settings.json'),
-  zh: () => import('./locales/zh/settings.json'),
-  'zh-TW': () => import('./locales/zh-TW/settings.json'),
-  'pt-BR': () => import('./locales/pt-BR/settings.json')
-}
-
 // Track which locales have been loaded
 const loadedLocales = new Set<string>(['en'])
 
@@ -101,48 +37,6 @@ const loadingLocales = new Map<string, Promise<void>>()
 // Store custom nodes i18n data for merging when locales are lazily loaded
 const customNodesI18nData: Record<string, unknown> = {}
 
-const SUPPORTED_LOCALES = [
-  'en',
-  'ar',
-  'es',
-  'fa',
-  'fr',
-  'ja',
-  'ko',
-  'ru',
-  'tr',
-  'zh',
-  'zh-TW',
-  'pt-BR'
-] as const
-
-type SupportedLocale = (typeof SUPPORTED_LOCALES)[number]
-
-// Lowercased lookup map → canonical tag, since BCP-47 matching is
-// case-insensitive (e.g. `pt-br` from older browsers must match `pt-BR`).
-const supportedLocaleByLower = new Map<string, SupportedLocale>(
-  SUPPORTED_LOCALES.map((locale) => [locale.toLowerCase(), locale])
-)
-
-/**
- * Resolve a BCP-47 language tag to a locale we ship messages for, with
- * graceful fallback. Tries the full tag (preserves `zh-TW`, `pt-BR`),
- * then the base tag (`zh`, `pt`), then `'en'`. Matching is case-insensitive
- * but the returned tag is always in canonical casing.
- */
-export function resolveSupportedLocale(
-  input: string | undefined | null
-): SupportedLocale {
-  if (!input) return 'en'
-  const normalized = input.toLowerCase()
-  const exact = supportedLocaleByLower.get(normalized)
-  if (exact) return exact
-  const base = normalized.split('-')[0]
-  const baseMatch = supportedLocaleByLower.get(base)
-  if (baseMatch) return baseMatch
-  return 'en'
-}
-
 /**
  * Dynamically load a locale and its associated files (nodeDefs, commands, settings).
  * Unsupported locales are clamped to `'en'`.
@@ -160,19 +54,19 @@ export async function loadLocale(locale: string): Promise<SupportedLocale> {
     return resolved
   }
 
-  const loader = localeLoaders[resolved]
-  const nodeDefsLoader = nodeDefsLoaders[resolved]
-  const commandsLoader = commandsLoaders[resolved]
-  const settingsLoader = settingsLoaders[resolved]
+  const loaders = localeDefinitions[resolved].loaders
+  if (!loaders) {
+    return resolved
+  }
 
   // Create and track the loading promise
   const loadPromise = (async () => {
     try {
       const [main, nodes, commands, settings] = await Promise.all([
-        loader(),
-        nodeDefsLoader(),
-        commandsLoader(),
-        settingsLoader()
+        loaders.main(),
+        loaders.nodeDefs(),
+        loaders.commands(),
+        loaders.settings()
       ])
 
       const messages = buildLocale(

src/locales/CONTRIBUTING.md

@@ -35,46 +35,20 @@ module.exports = defineConfig({
 })
 ```
 
-#### 1.2 Update `src/platform/settings/constants/coreSettings.ts`
+#### 1.2 Update `src/locales/localeConfig.ts`
 
-Add your language to the dropdown options:
+Add your language to the shared runtime locale definition. This feeds the
+settings dropdown, supported-locale resolution, and lazy locale loading:
 
 ```typescript
-{
-  id: 'Comfy.Locale',
-  name: 'Language',
-  type: 'combo',
-  options: [
-    { value: 'en', text: 'English' },
-    { value: 'zh', text: '中文' },
-    { value: 'zh-TW', text: '繁體中文 (台灣)' }, // Add your language here
-    { value: 'ru', text: 'Русский' },
-    { value: 'ja', text: '日本語' },
-    { value: 'ko', text: '한국어' },
-    { value: 'fr', text: 'Français' },
-    { value: 'es', text: 'Español' }
-  ],
-  defaultValue: () => navigator.language.split('-')[0] || 'en'
-},
-```
-
-#### 1.3 Update `src/i18n.ts`
-
-Add imports for your new language files:
-
-```typescript
-// Add these imports (replace zh-TW with your language code)
-import zhTWCommands from './locales/zh-TW/commands.json'
-import zhTW from './locales/zh-TW/main.json'
-import zhTWNodes from './locales/zh-TW/nodeDefs.json'
-import zhTWSettings from './locales/zh-TW/settings.json'
-
-// Add to the messages object
-const messages = {
-  en: buildLocale(en, enNodes, enCommands, enSettings),
-  zh: buildLocale(zh, zhNodes, zhCommands, zhSettings),
-  'zh-TW': buildLocale(zhTW, zhTWNodes, zhTWCommands, zhTWSettings) // Add this line
-  // ... other languages
+'zh-TW': {
+  text: '繁體中文 (台灣)',
+  loaders: {
+    main: () => import('./zh-TW/main.json'),
+    nodeDefs: () => import('./zh-TW/nodeDefs.json'),
+    commands: () => import('./zh-TW/commands.json'),
+    settings: () => import('./zh-TW/settings.json')
+  }
 }
 ```