Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: messages provided by layer vuei18n config files not merging #2286

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions specs/fixtures/layer_consumer/app.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<div>
<NuxtPage />
</div>
</template>

<style>
section {
margin: 1rem 0;
}
</style>
30 changes: 30 additions & 0 deletions specs/fixtures/layer_consumer/components/LangSwitcher.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<script setup lang="ts">
import { useI18n, useSwitchLocalePath } from '#i18n'

const { locales, locale, setLocale } = useI18n()
const switchLocalePath = useSwitchLocalePath()
</script>

<template>
<div>
<template v-for="locale in locales" :key="locale">
<section :id="`lang-switcher-with-nuxt-link-${locale}`">
<strong>Using <code>NuxtLink</code></strong
>:
<NuxtLink :exact="true" :to="switchLocalePath(locale)">{{ locale }}</NuxtLink>
</section>
<section id="lang-switcher-with-set-locale">
<strong>Using <code>setLocale()</code></strong
>:
<a :id="`set-locale-link-${locale}`" :key="`b-${locale}`" href="#" @click.prevent="setLocale(locale)">{{
locale
}}</a>
</section>
</template>
<section id="lang-switcher-current-locale">
<strong
>Current Locale: <code>{{ locale }}</code></strong
>:
</section>
</div>
</template>
1 change: 1 addition & 0 deletions specs/fixtures/layer_consumer/i18n.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default {}
10 changes: 10 additions & 0 deletions specs/fixtures/layer_consumer/layer-simple/i18n.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export default {
messages: {
fr: {
thanks: 'Merci!'
},
nl: {
thanks: 'Bedankt!'
}
}
}
10 changes: 10 additions & 0 deletions specs/fixtures/layer_consumer/layer-simple/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// https://nuxt.com/docs/guide/directory-structure/nuxt.config
export default defineNuxtConfig({
modules: ['@nuxtjs/i18n'],
i18n: {
locales: ['fr', 'nl'],
defaultLocale: 'nl',
detectBrowserLanguage: false,
vueI18n: './i18n.config.ts'
}
})
5 changes: 5 additions & 0 deletions specs/fixtures/layer_consumer/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// https://nuxt.com/docs/guide/directory-structure/nuxt.config
export default defineNuxtConfig({
extends: ['./layer-simple'],
modules: ['@nuxtjs/i18n']
})
14 changes: 14 additions & 0 deletions specs/fixtures/layer_consumer/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "nuxt3-test-fallback",
"private": true,
"type": "module",
"scripts": {
"dev": "nuxi dev",
"build": "nuxt build",
"start": "node .output/server/index.mjs"
},
"devDependencies": {
"@nuxtjs/i18n": "latest",
"nuxt": "latest"
}
}
30 changes: 30 additions & 0 deletions specs/fixtures/layer_consumer/pages/index.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<script setup lang="ts">
import { useHead } from '#imports'
import { useI18n, useLocalePath, useLocaleHead } from '#i18n'
import LangSwitcher from '../components/LangSwitcher.vue'

const { t } = useI18n()
const localePath = useLocalePath()
const i18nHead = useLocaleHead({ addSeoAttributes: { canonicalQueries: ['page'] } })

useHead({
title: t('home'),
htmlAttrs: {
lang: i18nHead.value.htmlAttrs!.lang
},
link: [...(i18nHead.value.link || [])],
meta: [...(i18nHead.value.meta || [])]
})
</script>

<template>
<div>
<div id="layer-message">{{ $t('thanks') }}</div>
<LangSwitcher />
<section>
<strong><code>useHead</code> with <code>useLocaleHead</code></strong
>:
<code id="home-use-locale-head">{{ i18nHead }}</code>
</section>
</div>
</template>
19 changes: 19 additions & 0 deletions specs/layers/layers_vuei18n_options.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { describe, test, expect } from 'vitest'
import { fileURLToPath } from 'node:url'
import { setup, url, createPage } from '../utils'
import { getText } from '../helper'

describe('nuxt layers vuei18n options', async () => {
await setup({
rootDir: fileURLToPath(new URL(`../fixtures/layer_consumer`, import.meta.url)),
browser: true
})

test('layer vueI18n options provides `nl` message', async () => {
const home = url('/')
const page = await createPage(undefined) // set browser locale
await page.goto(home)

expect(await getText(page, '#layer-message')).toEqual('Bedankt!')
})
})
4 changes: 3 additions & 1 deletion src/gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ export function generateLoaderOptions(
} else {
genCodes += ` ${rootKey}.${key} = ${toCode({})}\n`
}
genCodes += ` ${rootKey}.${key}.messages ??= {}\n`

if (vueI18nConfigPaths.length > 0) {
genCodes += ` const deepCopy = (src, des, predicate) => {
Expand All @@ -199,9 +200,10 @@ export function generateLoaderOptions(
}
const mergeMessages = async (messages, loader) => {
const layerConfig = await vueI18nConfigLoader(loader)
const vueI18n = layerConfig.vueI18n || {}
const vueI18n = layerConfig || {}
const layerMessages = vueI18n.messages || {}
for (const [locale, message] of Object.entries(layerMessages)) {
messages[locale] ??= {}
deepCopy(message, messages[locale])
}
}
Expand Down
4 changes: 3 additions & 1 deletion test/__snapshots__/gen.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ export const resolveNuxtI18nOptions = async (context) => {
: {}
}
nuxtI18nOptions.vueI18n = Object({})
nuxtI18nOptions.vueI18n.messages ??= {}
const deepCopy = (src, des, predicate) => {
for (const key in src) {
if (typeof src[key] === 'object') {
Expand All @@ -180,9 +181,10 @@ export const resolveNuxtI18nOptions = async (context) => {
}
const mergeMessages = async (messages, loader) => {
const layerConfig = await vueI18nConfigLoader(loader)
const vueI18n = layerConfig.vueI18n || {}
const vueI18n = layerConfig || {}
const layerMessages = vueI18n.messages || {}
for (const [locale, message] of Object.entries(layerMessages)) {
messages[locale] ??= {}
deepCopy(message, messages[locale])
}
}
Expand Down