From 79c9e8e7c080a69ec96ee865e78f1b4de28eb611 Mon Sep 17 00:00:00 2001
From: yeeway <yiwei.suuu@gmail.com>
Date: Wed, 30 Sep 2026 11:59:59 +0200
Subject: [PATCH] fix(i18n): support hyphenated locale codes

---
 layer/app/app.vue                      |  5 +-
 layer/app/components/app/AppSearch.vue |  3 +-
 layer/app/error.vue                    |  5 +-
 layer/app/pages/[[lang]]/[...slug].vue |  3 +-
 layer/app/plugins/i18n.ts              |  6 +--
 layer/app/templates/landing.vue        |  3 +-
 layer/content.config.ts                | 19 ++++---
 layer/modules/config.ts                | 74 ++++++++++++++++----------
 layer/server/api/__sitemap__/urls.ts   |  3 +-
 layer/server/utils/content.ts          |  5 +-
 layer/utils/locale.ts                  | 20 +++++++
 layer/utils/pages.ts                   | 13 ++++-
 12 files changed, 109 insertions(+), 50 deletions(-)
 create mode 100644 layer/utils/locale.ts

diff --git a/layer/app/app.vue b/layer/app/app.vue
index c1126ba1d..26a5b2890 100644
--- a/layer/app/app.vue
+++ b/layer/app/app.vue
@@ -1,6 +1,7 @@
 <script setup lang="ts">
 import type { ContentNavigationItem, PageCollections } from '@nuxt/content'
 import * as nuxtUiLocales from '@nuxt/ui/locale'
+import { getLocaleKey } from '../utils/locale'
 import { transformNavigation } from './utils/navigation'
 import { useDocusShortcuts } from './composables/useDocusShortcuts'
 import { useSubNavigation } from './composables/useSubNavigation'
@@ -12,10 +13,10 @@ const site = useSiteConfig()
 const { locale, locales, isEnabled, switchLocalePath } = useDocusI18n()
 const { isEnabled: isAssistantEnabled } = useAssistant()
 
-const nuxtUiLocale = computed(() => nuxtUiLocales[locale.value as keyof typeof nuxtUiLocales] || nuxtUiLocales.en)
+const nuxtUiLocale = computed(() => nuxtUiLocales[getLocaleKey(locale.value) as keyof typeof nuxtUiLocales] || nuxtUiLocales.en)
 const lang = computed(() => nuxtUiLocale.value.code)
 const dir = computed(() => nuxtUiLocale.value.dir)
-const collectionName = computed(() => isEnabled.value ? `docs_${locale.value}` : 'docs')
+const collectionName = computed(() => isEnabled.value ? `docs_${getLocaleKey(locale.value)}` : 'docs')
 
 useHead({
   meta: [
diff --git a/layer/app/components/app/AppSearch.vue b/layer/app/components/app/AppSearch.vue
index 0e744c95f..934cb99ea 100644
--- a/layer/app/components/app/AppSearch.vue
+++ b/layer/app/components/app/AppSearch.vue
@@ -1,5 +1,6 @@
 <script setup lang="ts">
 import type { ContentNavigationItem, PageCollections } from '@nuxt/content'
+import { getLocaleKey } from '../../../utils/locale'
 
 const props = defineProps<{
   navigation?: ContentNavigationItem[]
@@ -9,7 +10,7 @@ const appConfig = useAppConfig()
 const { forced: forcedColorMode } = useDocusColorMode()
 const { locale, isEnabled } = useDocusI18n()
 
-const collectionName = computed(() => (isEnabled.value ? `docs_${locale.value}` : 'docs') as keyof PageCollections)
+const collectionName = computed(() => (isEnabled.value ? `docs_${getLocaleKey(locale.value)}` : 'docs') as keyof PageCollections)
 const useFts = appConfig.search.fts
 
 const { data: files } = useFts
diff --git a/layer/app/error.vue b/layer/app/error.vue
index d713055c1..91f50ea21 100644
--- a/layer/app/error.vue
+++ b/layer/app/error.vue
@@ -2,6 +2,7 @@
 import type { NuxtError } from '#app'
 import type { ContentNavigationItem, PageCollections } from '@nuxt/content'
 import * as nuxtUiLocales from '@nuxt/ui/locale'
+import { getLocaleKey } from '../utils/locale'
 import { transformNavigation } from './utils/navigation'
 
 const props = defineProps<{
@@ -10,7 +11,7 @@ const props = defineProps<{
 
 const { locale, locales, isEnabled, t, switchLocalePath } = useDocusI18n()
 
-const nuxtUiLocale = computed(() => nuxtUiLocales[locale.value as keyof typeof nuxtUiLocales] || nuxtUiLocales.en)
+const nuxtUiLocale = computed(() => nuxtUiLocales[getLocaleKey(locale.value) as keyof typeof nuxtUiLocales] || nuxtUiLocales.en)
 const lang = computed(() => nuxtUiLocale.value.code)
 const dir = computed(() => nuxtUiLocale.value.dir)
 
@@ -45,7 +46,7 @@ if (isEnabled.value) {
   })
 }
 
-const collectionName = computed(() => isEnabled.value ? `docs_${locale.value}` : 'docs')
+const collectionName = computed(() => isEnabled.value ? `docs_${getLocaleKey(locale.value)}` : 'docs')
 
 const { data: navigation } = await useAsyncData(`navigation_${collectionName.value}`, () => queryCollectionNavigation(collectionName.value as keyof PageCollections), {
   transform: (data: ContentNavigationItem[]) => transformNavigation(data, isEnabled.value, locale.value),
diff --git a/layer/app/pages/[[lang]]/[...slug].vue b/layer/app/pages/[[lang]]/[...slug].vue
index 9c426f4a8..05677a0ec 100644
--- a/layer/app/pages/[[lang]]/[...slug].vue
+++ b/layer/app/pages/[[lang]]/[...slug].vue
@@ -2,6 +2,7 @@
 import { kebabCase } from 'scule'
 import type { ContentNavigationItem, Collections, DocsCollectionItem } from '@nuxt/content'
 import { findPageHeadline } from '@nuxt/content/utils'
+import { getLocaleKey } from '../../../utils/locale'
 
 definePageMeta({
   layout: 'docs',
@@ -12,7 +13,7 @@ const { locale, isEnabled, t } = useDocusI18n()
 const { isOpen } = useAssistant()
 const appConfig = useAppConfig()
 const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
-const collectionName = computed(() => isEnabled.value ? `docs_${locale.value}` : 'docs')
+const collectionName = computed(() => isEnabled.value ? `docs_${getLocaleKey(locale.value)}` : 'docs')
 
 const [{ data: page }, { data: surround }] = await Promise.all([
   useAsyncData(kebabCase(route.path), () => queryCollection(collectionName.value as keyof Collections).path(route.path).first() as Promise<DocsCollectionItem>),
diff --git a/layer/app/plugins/i18n.ts b/layer/app/plugins/i18n.ts
index 1d568b72d..2743daae9 100644
--- a/layer/app/plugins/i18n.ts
+++ b/layer/app/plugins/i18n.ts
@@ -1,5 +1,6 @@
 import type { RouteLocationNormalized } from 'vue-router'
 import { consola } from 'consola'
+import { findLocaleFile } from '../../utils/locale'
 
 const log = consola.withTag('docus')
 
@@ -19,9 +20,8 @@ export default defineNuxtPlugin(async () => {
     let locale = configuredLocale
     let resolvedMessages: Record<string, unknown>
 
-    // Try to load the requested locale file
-    const localeKey = `../../i18n/locales/${configuredLocale}.json`
-    const localeLoader = localeFiles[localeKey]
+    const fileName = findLocaleFile(configuredLocale, Object.keys(localeFiles).map(key => key.split('/').pop()!))
+    const localeLoader = fileName ? localeFiles[`../../i18n/locales/${fileName}`] : undefined
 
     if (localeLoader) {
       const localeModule = await localeLoader()
diff --git a/layer/app/templates/landing.vue b/layer/app/templates/landing.vue
index 160ee0000..550d8d3cc 100644
--- a/layer/app/templates/landing.vue
+++ b/layer/app/templates/landing.vue
@@ -1,11 +1,12 @@
 <script setup lang="ts">
 import type { Collections } from '@nuxt/content'
+import { getLocaleKey } from '../../utils/locale'
 
 const route = useRoute()
 const { locale, isEnabled } = useDocusI18n()
 
 // Dynamic collection name based on i18n status
-const collectionName = computed(() => isEnabled.value ? `landing_${locale.value}` : 'landing')
+const collectionName = computed(() => isEnabled.value ? `landing_${getLocaleKey(locale.value)}` : 'landing')
 
 const { data: page } = await useAsyncData(collectionName.value, () => queryCollection(collectionName.value as keyof Collections).path(route.path).first())
 if (!page.value) {
diff --git a/layer/content.config.ts b/layer/content.config.ts
index b6a989058..94df66deb 100644
--- a/layer/content.config.ts
+++ b/layer/content.config.ts
@@ -2,7 +2,8 @@ import type { DefinedCollection } from '@nuxt/content'
 import { defineContentConfig, defineCollection, z } from '@nuxt/content'
 import { useNuxt } from '@nuxt/kit'
 import { joinURL } from 'ufo'
-import { landingPageExists, docsFolderExists } from './utils/pages'
+import { landingPageExists, docsFolderExists, findLocaleFolder } from './utils/pages'
+import { getLocaleKey, normalizeLocale } from './utils/locale'
 
 const { options } = useNuxt()
 const cwd = joinURL(options.rootDir, 'content')
@@ -25,26 +26,28 @@ let collections: Record<string, DefinedCollection>
 if (locales && Array.isArray(locales)) {
   collections = {}
   for (const locale of locales) {
-    const code = (typeof locale === 'string' ? locale : locale.code).replace('-', '_')
-    const hasLocaleDocs = docsFolderExists(options.rootDir, code)
+    const code = normalizeLocale(typeof locale === 'string' ? locale : locale.code)
+    const collectionKey = getLocaleKey(code)
+    const dir = findLocaleFolder(options.rootDir, code) || code
+    const hasLocaleDocs = docsFolderExists(options.rootDir, dir)
 
     if (!hasLandingPage) {
-      collections[`landing_${code}`] = defineCollection({
+      collections[`landing_${collectionKey}`] = defineCollection({
         type: 'page',
         source: {
           cwd,
-          include: `${code}/index.md`,
+          include: `${dir}/index.md`,
         },
       })
     }
 
-    collections[`docs_${code}`] = defineCollection({
+    collections[`docs_${collectionKey}`] = defineCollection({
       type: 'page',
       source: {
         cwd,
-        include: hasLocaleDocs ? `${code}/docs/**` : `${code}/**/*`,
+        include: hasLocaleDocs ? `${dir}/docs/**` : `${dir}/**/*`,
         prefix: hasLocaleDocs ? `/${code}/docs` : `/${code}`,
-        exclude: [`${code}/index.md`],
+        exclude: [`${dir}/index.md`],
       },
       schema: createDocsSchema(),
     })
diff --git a/layer/modules/config.ts b/layer/modules/config.ts
index 2bbc68033..0d402066f 100644
--- a/layer/modules/config.ts
+++ b/layer/modules/config.ts
@@ -1,19 +1,20 @@
 import { createResolver, defineNuxtModule, logger } from '@nuxt/kit'
 import { defu } from 'defu'
-import { existsSync } from 'node:fs'
-import { join } from 'node:path'
+import { readdirSync } from 'node:fs'
 import type { ModuleOptions as AgentDiscoveryOptions } from 'nuxt-agent-discovery'
+import { findLocaleFile, normalizeLocale } from '../utils/locale'
+import { findLocaleFolder } from '../utils/pages'
 import { inferSiteURL, getPackageJsonMetadata } from '../utils/meta'
 import { getGitBranch, getGitEnv, getLocalGitInfo } from '../utils/git'
 
 const log = logger.withTag('docus')
 
-type I18nLocale = string | { code: string, name?: string }
-type DocusI18nOptions = { locales?: I18nLocale[], strategy?: string }
+type I18nLocale = string | { code: string, name?: string, language?: string }
+type DocusI18nOptions = { locales?: I18nLocale[], defaultLocale?: string, strategy?: string }
 type DocusMcpOptions = { route?: string, enabled?: boolean, name?: string, browserRedirect?: string }
 type RegisterModuleOptions = {
   langDir: string
-  locales: Array<{ code: string, name: string, file: string }>
+  locales: Array<{ code: string, name: string, language: string, file: string }>
 }
 
 export default defineNuxtModule({
@@ -126,36 +127,61 @@ export default defineNuxtModule({
 
     if (i18nOptions && typeof i18nOptions === 'object' && i18nOptions.locales) {
       const { resolve } = createResolver(import.meta.url)
+      const langDir = resolve('../i18n/locales')
+      const localeFileNames = readdirSync(langDir)
+
+      // Keep the original tag as `language` for `html lang` and `hreflang`
+      const normalizeLocaleEntry = (locale: I18nLocale) => {
+        const code = typeof locale === 'string' ? locale : locale.code
+        const base = typeof locale === 'string' ? { name: code, language: code } : locale
+
+        return { ...base, code: normalizeLocale(code), language: base.language || code }
+      }
+
+      const normalizedLocales = i18nOptions.locales.map(normalizeLocaleEntry)
 
       // Filter locales to only include existing ones
-      const filteredLocales = i18nOptions.locales.filter((locale: I18nLocale) => {
-        const localeCode = typeof locale === 'string' ? locale : locale.code
+      const filteredLocales = normalizedLocales.filter((locale) => {
+        const localeCode = locale.code
 
         // Check for JSON locale file
-        const localeFilePath = resolve('../i18n/locales', `${localeCode}.json`)
-        const hasLocaleFile = existsSync(localeFilePath)
+        const localeFile = findLocaleFile(localeCode, localeFileNames)
 
         // Check for content folder
-        const contentPath = join(nuxt.options.rootDir, 'content', localeCode)
-        const hasContentFolder = existsSync(contentPath)
+        const contentFolder = findLocaleFolder(nuxt.options.rootDir, localeCode)
 
-        if (!hasLocaleFile) {
+        if (!localeFile) {
           log.warn(`Locale file not found: ${localeCode}.json - skipping locale "${localeCode}"`)
         }
 
-        if (!hasContentFolder) {
+        if (!contentFolder) {
           log.warn(`Content folder not found: content/${localeCode}/ - skipping locale "${localeCode}"`)
         }
 
-        return hasLocaleFile && hasContentFolder
+        return !!localeFile && !!contentFolder
       })
 
       // Override strategy to prefix
       typedNuxtOptions.i18n = {
         ...i18nOptions,
+        locales: normalizedLocales,
+        defaultLocale: i18nOptions.defaultLocale && normalizeLocale(i18nOptions.defaultLocale),
         strategy: 'prefix',
       }
 
+      // @nuxtjs/i18n reads locales from each layer config, not from the merged options
+      for (const layer of nuxt.options._layers) {
+        const layerI18n = (layer.config as { i18n?: DocusI18nOptions }).i18n
+
+        if (layerI18n?.locales) {
+          layerI18n.locales = layerI18n.locales.map(normalizeLocaleEntry)
+
+          if (layerI18n.defaultLocale) {
+            layerI18n.defaultLocale = normalizeLocale(layerI18n.defaultLocale)
+          }
+        }
+      }
+
       // Expose filtered locales
       nuxt.options.runtimeConfig.public.docus = {
         ...nuxt.options.runtimeConfig.public.docus,
@@ -177,20 +203,12 @@ export default defineNuxtModule({
       const registerI18nModule = nuxt.hook as unknown as (name: string, callback: (register: (options: RegisterModuleOptions) => void) => void) => void
 
       registerI18nModule('i18n:registerModule', (register) => {
-        const langDir = resolve('../i18n/locales')
-
-        const locales = filteredLocales.map((locale: I18nLocale) => {
-          return typeof locale === 'string'
-            ? {
-                code: locale,
-                name: locale,
-                file: `${locale}.json`,
-              }
-            : {
-                code: locale.code,
-                name: locale.name || locale.code,
-                file: `${locale.code}.json`,
-              }
+        const locales = filteredLocales.flatMap((locale) => {
+          const file = findLocaleFile(locale.code, localeFileNames)
+
+          return file
+            ? [{ code: locale.code, name: locale.name || locale.code, language: locale.language, file }]
+            : []
         })
 
         register({
diff --git a/layer/server/api/__sitemap__/urls.ts b/layer/server/api/__sitemap__/urls.ts
index 39888513f..9af5a18a9 100644
--- a/layer/server/api/__sitemap__/urls.ts
+++ b/layer/server/api/__sitemap__/urls.ts
@@ -1,4 +1,5 @@
 import { queryCollection } from '@nuxt/content/server'
+import { getLocaleKey } from '../../../utils/locale'
 import { getAvailableLocales, getCollectionsToQuery, isNavigationPath } from '../../utils/content'
 
 type Page = Record<string, unknown> & { path?: string, meta?: Record<string, unknown> }
@@ -15,7 +16,7 @@ export default defineSitemapEventHandler(async (event) => {
 
   if (availableLocales.length > 0) {
     for (const locale of availableLocales) {
-      collections.push(`landing_${locale}`)
+      collections.push(`landing_${getLocaleKey(locale)}`)
     }
   }
   else {
diff --git a/layer/server/utils/content.ts b/layer/server/utils/content.ts
index 4dee823bd..9e18d07dd 100644
--- a/layer/server/utils/content.ts
+++ b/layer/server/utils/content.ts
@@ -1,4 +1,5 @@
 import type { LocaleObject } from '@nuxtjs/i18n'
+import { getLocaleKey } from '../../utils/locale'
 
 type ConfigWithLocales = {
   i18n?: { locales?: Array<string | LocaleObject> }
@@ -17,11 +18,11 @@ export function getAvailableLocales(config: ConfigWithLocales): string[] {
 
 export function getCollectionsToQuery(locale: string | undefined, availableLocales: string[]): string[] {
   if (locale && availableLocales.includes(locale)) {
-    return [`docs_${locale}`]
+    return [`docs_${getLocaleKey(locale)}`]
   }
 
   return availableLocales.length > 0
-    ? availableLocales.map(l => `docs_${l}`)
+    ? availableLocales.map(l => `docs_${getLocaleKey(l)}`)
     : ['docs']
 }
 
diff --git a/layer/utils/locale.ts b/layer/utils/locale.ts
new file mode 100644
index 000000000..3a4b549ec
--- /dev/null
+++ b/layer/utils/locale.ts
@@ -0,0 +1,20 @@
+/**
+ * Nuxt Content lowercases every path it generates, so an uppercase code would
+ * never match its own pages. The original tag is kept as the locale `language`.
+ */
+export function normalizeLocale(code: string): string {
+  return code.toLowerCase()
+}
+
+/**
+ * Collection names must be valid identifiers, so hyphens become underscores.
+ * `@nuxt/ui/locale` export names use the same form.
+ */
+export function getLocaleKey(code: string): string {
+  return normalizeLocale(code).replace(/-/g, '_')
+}
+
+/** Locale files keep their BCP 47 name, so match them on the normalized code. */
+export function findLocaleFile(code: string, fileNames: string[]): string | undefined {
+  return fileNames.find(fileName => fileName.toLowerCase() === `${normalizeLocale(code)}.json`)
+}
diff --git a/layer/utils/pages.ts b/layer/utils/pages.ts
index f0fa1f5b5..25fcd4747 100644
--- a/layer/utils/pages.ts
+++ b/layer/utils/pages.ts
@@ -1,4 +1,4 @@
-import { existsSync } from 'node:fs'
+import { existsSync, readdirSync } from 'node:fs'
 import { joinURL } from 'ufo'
 
 /**
@@ -20,3 +20,14 @@ export function docsFolderExists(rootDir: string, locale?: string): boolean {
     : joinURL(rootDir, 'content', 'docs')
   return existsSync(docsPath)
 }
+
+/**
+ * Finds the content folder for a locale, ignoring case so `content/zh-TW/` and
+ * `content/zh-tw/` both work. Returns the name as it is on disk.
+ */
+export function findLocaleFolder(rootDir: string, locale: string): string | undefined {
+  const contentDir = joinURL(rootDir, 'content')
+  if (!existsSync(contentDir)) return undefined
+
+  return readdirSync(contentDir).find(dir => dir.toLowerCase() === locale)
+}