Roadmap for v9

[kazupon]

Discussed in #2814

^{Originally posted by BobbieGoede February 20, 2024}

[!NOTE]
This list is incomplete and a work in progress, feel free to suggest features, topics or issues that you think should be included in v9.

There's still plenty of issues open for v8 and we'll continue to work on fixing those, this roadmap is simply to plan and discuss changes that would be breaking. There is currently no estimate or deadline for the next major version, you don't have to worry about migrating (again) anytime soon.

Features

• support vue-i18n v10
• support nuxt 4

Bug Fixes

• support v-t fully SSR

Breaking changes

• chore!: remove deprecated legacy dynamic route params #2801
• Rename locales property iso to language
  • Add alias as described in Language tags used in locales #2449 (comment) to allow for easier transition
• Add option to add lang attribute to useLocaleHead composable #2712
• Restructure runtimeConfig keys
  • Rename locales to domainLocales and configLocales to locales (refactor: pass generated options through runtimeConfig #2828 (comment))
• enable jit compilation as default (remove jit option) https://i18n.nuxtjs.org/docs/options/compilation#jit
• Fix prefixed injected functions (_ctx.$localePath is not a function #2168), this is a breaking change as currently the unprefixed inject functions do work but should not and prefixed functions don't.
• Changing/aligning useLocaleHead and useSetI18nParams argument defaults

Postponed

• Change route localization to omit parent from path in defineI18nRoute as described in fix: custom child route localization #2743 (comment)
  • This can be a non-breaking change if we implement this using relative paths as described in I18n Routing [DRAFT] nuxt/nuxt#28826 (comment)
• allow configuration from app.config.ts and extending (@nuxt/schema).AppConfig #1985
  • This is a non trivial change, options used at build time should be taken into consideration, as well as layer support and more. Feel free to open issues, PRs or open a discussion to brainstorm solutions.

Considering

• Change locales configuration
  • Remove file, only accepting files array instead, simplifies options merging.

[MinecraftStorage1]

Can you also add support for custom routing? So that routes defined in router.options.js file are also prefixed. Many big websites prefer custom routing because of the greater flexibility it offers. But as I18n doesn't support auto prefixing for custom routes, it makes the module almost obsolete for such applications.

[MuhammadM1998]

Thanks for the great effort🙏 I'd suggest flattening the modules & vue-i18n configs as it's confusing. Abstracting vue-i18n config and exposing relevant options to the module's config would be a better imo

[kazupon]

@MuhammadM1998
Thanks comment!

As mentioned here, the config flattening of nuxt-i18n and vue-i18n is on this roadmap. However, that's a rather disruptive change. So we may postpone it to the next major version as we have to prioritise nuxt4.

[NordsKingArt]

@kazupon are you going to ignore the comment by @MinecraftStorage1? I think it quite makes sense adding support for custom routes. I thought even if there is no support for auto prefixing, maybe you will make it possible to use composables like useLocalePath or useSwitchLocalePath? Right now only limited functionalities are available for custom routing.

[BobbieGoede]

@MinecraftStorage1 @NordsKingArt
Please open a separate issue describing this feature (or add details to an issue specific to it if it already exists).

The changes in v9 are mostly focused on deprecating and removing old features and updating dependencies to their next majors (e.g. Nuxt 4, Vue I18n v10) since these usually introduce breaking changes.

[BobbieGoede]

I think I will postpone the flattening/merging of nuxt-i18n and vue-i18n for a later major version, I don't have a clear approach on how to do this and there's larger structural changes I would like to make that could make it easier.

The main priorities will be supporting Nuxt 4 and smaller (long-standing) breaking changes.

[kazupon]

@BobbieGoede
I agree.
I don't have a good idea for config flat, so let's postpone that and focus on Nuxt4 support first!

[BobbieGoede]

I think we can publish a first release candidate soon, and if all goes well, I estimate we'll have a stable release somewhere in October 💪

[kazupon]

Well done!

I'm currently a bit busy with preparations for Vue Fes Japan, so I'll leave the release to you!
It will be your first experience of releasing a major release!

[BobbieGoede]

Closing this as we have made the breaking changes needed and published the first release candidate. (This release has an issue for projects using npm #3152)

I have opened an issue (#3163) to track one of the possible changes I originally wanted to make for v9, but I believe it can be made in a non-breaking way so it can still be implemented during v9's development.

I hope the typescript improvements should attract more users to try out the release candidate, feedback is all we need to determine v9's stability and whether it's time for a stable major release 💪