fix!: restructureDir defaults (#3106)

* fix!: `restructureDir` defaults * docs: document disabling `restructureDir` * fix: `restructureDir` type description * fix: remove console log * chore: fix playground config
nuxt-modules · Sep 17, 2024 · 3e33699 · 3e33699
1 parent 73f6b99
commit 3e33699
Show file tree

Hide file tree

Showing 30 changed files with 465 additions and 123 deletions.
diff --git a/docs/content/docs/5.v9/2.guide/19.breaking-changes-in-v9.md b/docs/content/docs/5.v9/2.guide/19.breaking-changes-in-v9.md
@@ -48,6 +48,8 @@ Reasons for change
   1. Context - i18n files are used both server-side and client-side, using a dedicated `i18n/` folder in the root directory outside `app/` and `server/` makes more sense.
   2. Clean - less clutter/fragmentation of i18n files, and should make resolving and loading files easier for us.
 
+To ease the migration to v9 you can disable this feature by setting `restructureDir: false`, this will be removed in v10.
+
 ## Locale `iso` renamed to `language`
 
 The `iso` property on a locale object has been renamed to `language` to be consistent with the usage of Language Tags on the web (e.g. `navigator.language` and `Accept-Language`). The original `iso` property name referred to ISO standards which describe valid Language Tags, see the [related issue](https://github.com/nuxt-modules/i18n/issues/2449) for more details.

diff --git a/package.json b/package.json
@@ -91,7 +91,7 @@
     "@intlify/unplugin-vue-i18n": "^5.0.0",
     "@intlify/utils": "^0.13.0",
     "@miyaneee/rollup-plugin-json5": "^1.2.0",
-    "@nuxt/kit": "^3.13.1",
+    "@nuxt/kit": "^3.13.2",
     "@rollup/plugin-yaml": "^4.1.2",
     "@vue/compiler-sfc": "^3.5.5",
     "debug": "^4.3.5",
@@ -115,7 +115,7 @@
     "@babel/types": "^7.24.7",
     "@eslint/js": "9.5.0",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.13.1",
+    "@nuxt/schema": "^3.13.2",
     "@types/debug": "^4.1.9",
     "@types/eslint": "^8.56.6",
     "@unhead/vue": "^1.8.8",
@@ -134,7 +134,7 @@
     "lint-staged": "^15.2.7",
     "nitropack": "^2.9.7",
     "npm-run-all2": "^6.2.0",
-    "nuxt": "^3.13.1",
+    "nuxt": "^3.13.2",
     "ofetch": "^1.3.4",
     "pkg-pr-new": "^0.0.20",
     "playwright-core": "^1.45.3",

diff --git a/playground/layers/i18n-layer/nuxt.config.ts b/playground/layers/i18n-layer/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     langDir: 'locales',
     lazy: true,
     baseUrl: 'http://localhost:3000',

diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -117,6 +117,7 @@ export default defineNuxtConfig({
   // },
   // debug: true,
   i18n: {
+    restructureDir: false,
     experimental: {
       localeDetector: './localeDetector.ts',
       switchLocalePathLinkSSR: true,

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/specs/fixtures/basic/nuxt.config.ts b/specs/fixtures/basic/nuxt.config.ts
@@ -5,6 +5,7 @@ export default defineNuxtConfig({
   modules: [CustomModule, '@nuxtjs/i18n'],
 
   i18n: {
+    restructureDir: false,
     lazy: false,
     baseUrl: 'http://localhost:3000',
     locales: [

diff --git a/specs/fixtures/basic_usage/nuxt.config.ts b/specs/fixtures/basic_usage/nuxt.config.ts
@@ -16,6 +16,7 @@ export default defineNuxtConfig({
   ],
   plugins: [`../plugins/i18nHooks.ts`],
   i18n: {
+    restructureDir: false,
     vueI18n: './config/i18n.config.ts',
     locales: ['en', 'fr'],
     defaultLocale: 'en',

diff --git a/specs/fixtures/basic_usage_compat_4/nuxt.config.ts b/specs/fixtures/basic_usage_compat_4/nuxt.config.ts
@@ -18,6 +18,7 @@ export default defineNuxtConfig({
   ],
   plugins: [`../plugins/i18nHooks.ts`],
   i18n: {
+    restructureDir: false,
     vueI18n: './config/i18n.config.ts',
     defaultLocale: 'en',
     experimental: {

diff --git a/specs/fixtures/different_domains/nuxt.config.ts b/specs/fixtures/different_domains/nuxt.config.ts
@@ -5,6 +5,7 @@ export default defineNuxtConfig({
   modules: [CustomModule, '@nuxtjs/i18n'],
 
   i18n: {
+    restructureDir: false,
     lazy: false,
     locales: [
       {

diff --git a/specs/fixtures/inline_options/nuxt.config.ts b/specs/fixtures/inline_options/nuxt.config.ts
@@ -28,6 +28,7 @@ export default defineNuxtConfig({
   ],
   debug: false,
   i18n: {
+    restructureDir: false,
     locales: [
       {
         code: 'ja',

diff --git a/specs/fixtures/issues/1888/nuxt.config.ts b/specs/fixtures/issues/1888/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     locales: [
       {
         code: 'en',

diff --git a/specs/fixtures/issues/2151/nuxt.config.ts b/specs/fixtures/issues/2151/nuxt.config.ts
@@ -6,6 +6,7 @@ export default defineNuxtConfig({
   },
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     lazy: true,
     langDir: 'locales',
     locales: [

diff --git a/specs/fixtures/issues/2220/nuxt.config.ts b/specs/fixtures/issues/2220/nuxt.config.ts
@@ -3,6 +3,7 @@ import locales from './locales'
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     lazy: true,
     langDir: 'locales',
     locales,

diff --git a/specs/fixtures/issues/2226/nuxt.config.ts b/specs/fixtures/issues/2226/nuxt.config.ts
@@ -1,6 +1,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     locales: ['en', 'de'],
     defaultLocale: 'en',
     strategy: 'prefix_and_default'

diff --git a/specs/fixtures/issues/2247/nuxt.config.ts b/specs/fixtures/issues/2247/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     baseUrl: 'https://abwaab.com',
     locales: [
       {

diff --git a/specs/fixtures/issues/2288/nuxt.config.ts b/specs/fixtures/issues/2288/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     baseUrl: 'https://abwaab.com',
     locales: [
       {

diff --git a/specs/fixtures/issues/2315/nuxt.config.ts b/specs/fixtures/issues/2315/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     bundle: {
       compositionOnly: false
     },

diff --git a/specs/fixtures/layers/layer-domain/nuxt.config.ts b/specs/fixtures/layers/layer-domain/nuxt.config.ts
@@ -1,6 +1,7 @@
 // https://nuxt.com/docs/guide/directory-structure/nuxt.config
 export default defineNuxtConfig({
   i18n: {
+    restructureDir: false,
     // lazy: false,
     // differentDomains: true,
     // defaultLocale: 'en',

diff --git a/specs/fixtures/layers/layer-lazy/nuxt.config.ts b/specs/fixtures/layers/layer-lazy/nuxt.config.ts
@@ -1,6 +1,7 @@
 // https://nuxt.com/docs/guide/directory-structure/nuxt.config
 export default defineNuxtConfig({
   i18n: {
+    restructureDir: false,
     langDir: 'locales',
     locales: [
       {

diff --git a/specs/fixtures/layers/layer-locale-arabic/nuxt.config.ts b/specs/fixtures/layers/layer-locale-arabic/nuxt.config.ts
@@ -1,6 +1,7 @@
 // https://nuxt.com/docs/guide/directory-structure/nuxt.config
 export default defineNuxtConfig({
   i18n: {
+    restructureDir: false,
     langDir: 'locales',
     locales: [
       {

diff --git a/specs/fixtures/layers/layer-server/nuxt.config.ts b/specs/fixtures/layers/layer-server/nuxt.config.ts
@@ -1,6 +1,7 @@
 // https://nuxt.com/docs/guide/directory-structure/nuxt.config
 export default defineNuxtConfig({
   i18n: {
+    restructureDir: false,
     experimental: {
       localeDetector: './localeDetector.ts'
     },

diff --git a/specs/fixtures/layers/layer-simple/nuxt.config.ts b/specs/fixtures/layers/layer-simple/nuxt.config.ts
@@ -1,6 +1,7 @@
 // https://nuxt.com/docs/guide/directory-structure/nuxt.config
 export default defineNuxtConfig({
   i18n: {
+    restructureDir: false,
     locales: ['fr', 'nl']
   }
 })
diff --git a/specs/fixtures/layers/layer-vueI18n-options/layer-simple-secondary/nuxt.config.ts b/specs/fixtures/layers/layer-vueI18n-options/layer-simple-secondary/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     locales: ['fr', 'nl', 'en'],
     defaultLocale: 'nl',
     detectBrowserLanguage: false,

diff --git a/specs/fixtures/layers/layer-vueI18n-options/layer-simple/nuxt.config.ts b/specs/fixtures/layers/layer-vueI18n-options/layer-simple/nuxt.config.ts
@@ -2,6 +2,7 @@
 export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     locales: ['fr', 'nl', 'en'],
     defaultLocale: 'nl',
     detectBrowserLanguage: false,

diff --git a/specs/fixtures/lazy/nuxt.config.ts b/specs/fixtures/lazy/nuxt.config.ts
@@ -22,6 +22,7 @@ export default defineNuxtConfig({
   },
   modules: [i18nModule, '@nuxtjs/i18n'],
   i18n: {
+    restructureDir: false,
     baseUrl: 'http://localhost:3000',
     // langDir: 'lang',
     // defaultLocale: 'fr',

diff --git a/specs/fixtures/multi_domains_locales/nuxt.config.ts b/specs/fixtures/multi_domains_locales/nuxt.config.ts
@@ -7,6 +7,7 @@ export default defineNuxtConfig({
   modules: [CustomModule, '@nuxtjs/i18n'],
 
   i18n: {
+    restructureDir: false,
     lazy: false,
     baseUrl: 'http://localhost:3000',
     locales: [

diff --git a/specs/fixtures/restructure/nuxt.config.ts b/specs/fixtures/restructure/nuxt.config.ts
@@ -24,6 +24,7 @@ export default defineNuxtConfig({
   modules: [i18nModule, '@nuxtjs/i18n'],
 
   i18n: {
+    restructureDir: false,
     baseUrl: 'http://localhost:3000',
     // langDir: 'lang',
     // defaultLocale: 'fr',

diff --git a/specs/fixtures/routing/nuxt.config.ts b/specs/fixtures/routing/nuxt.config.ts
@@ -3,6 +3,7 @@ export default defineNuxtConfig({
   modules: ['@nuxtjs/i18n'],
 
   i18n: {
+    restructureDir: false,
     locales: ['en', 'ja'],
     detectBrowserLanguage: false
   }

diff --git a/src/layers.ts b/src/layers.ts
@@ -97,8 +97,9 @@ export function resolveI18nDir(layer: NuxtConfigLayer, i18n: NuxtI18nOptions, fr
 }
 
 export function resolveLayerLangDir(layer: NuxtConfigLayer, i18n: NuxtI18nOptions) {
-  const langDir = i18n.langDir ?? (i18n.restructureDir ? 'locales' : '')
-  return resolve(resolveI18nDir(layer, i18n), langDir)
+  i18n.restructureDir ??= 'i18n'
+  i18n.langDir ??= i18n.restructureDir !== false ? 'locales' : ''
+  return resolve(resolveI18nDir(layer, i18n), i18n.langDir)
 }
 
 const mergeLayerLocales = (options: NuxtI18nOptions, nuxt: Nuxt) => {

diff --git a/src/types.ts b/src/types.ts
@@ -110,11 +110,11 @@ export type NuxtI18nOptions<
   vueI18n?: string
   experimental?: ExperimentalFeatures
   /**
-   * This can be set to a directory name to opt into the directory restructure for v9 which will have a default of 'i18n'.
+   * The directory to resolve i18n files from, the restructure can be disabled by setting this to `false`.
    *
-   * @defaultValue `undefined` (v8) or `'i18n'` (v9 release)
+   * @defaultValue `'i18n'`
    */
-  restructureDir?: string
+  restructureDir?: string | false
   bundle?: BundleOptions
   compilation?: LocaleMessageCompilationOptions
   customBlocks?: CustomBlocksOptions