fix: rename locale `iso` property to `language` #3055

BobbieGoede · 2024-08-08T19:04:31Z

🔗 Linked issue

Language tags used in locales #2449

❓ Type of change

📖 Documentation (updates to the documentation, readme or JSdoc annotations)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
🧹 Chore (updates to the build process or auxiliary tools and libraries)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

As discussed in #2449, this renames the iso key to language to better fit the usage of the property.

This PR should be backwards compatible but will log a warning when iso is being used instead of language. We should again remember to remove the backwards compatibility before releasing v9.

📝 Checklist

I have linked an issue or discussion.
I have added tests (if possible).
I have updated the documentation accordingly.

BobbieGoede · 2024-08-08T19:05:58Z

specs/basic_usage.spec.ts

@@ -141,7 +141,7 @@ describe('basic usage', async () => {
    )

    expect(await getText(page, '#locale-head')).toMatchInlineSnapshot(
-      `"{ "htmlAttrs": { "lang": "en" }, "link": [ { "hid": "i18n-alt-en", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "en" }, { "hid": "i18n-alt-fr", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr" }, { "hid": "i18n-alt-ja", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja" }, { "hid": "i18n-alt-ja-JP", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja-JP" }, { "hid": "i18n-alt-nl", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl" }, { "hid": "i18n-alt-nl-NL", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl-NL" }, { "hid": "i18n-alt-kr", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr" }, { "hid": "i18n-alt-kr-KO", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr-KO" }, { "hid": "i18n-xd", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "x-default" }, { "hid": "i18n-can", "rel": "canonical", "href": "/nuxt-context-extension" } ], "meta": [ { "hid": "i18n-og-url", "property": "og:url", "content": "/nuxt-context-extension" }, { "hid": "i18n-og", "property": "og:locale", "content": "en" }, { "hid": "i18n-og-alt-fr", "property": "og:locale:alternate", "content": "fr" }, { "hid": "i18n-og-alt-ja-JP", "property": "og:locale:alternate", "content": "ja_JP" }, { "hid": "i18n-og-alt-nl-NL", "property": "og:locale:alternate", "content": "nl_NL" }, { "hid": "i18n-og-alt-kr-KO", "property": "og:locale:alternate", "content": "kr_KO" } ] }"`
+      `"{ "htmlAttrs": { "lang": "en" }, "link": [ { "hid": "i18n-alt-en", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "en" }, { "hid": "i18n-alt-fr", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr" }, { "hid": "i18n-alt-fr-FR", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr-FR" }, { "hid": "i18n-alt-ja", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja" }, { "hid": "i18n-alt-ja-JP", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja-JP" }, { "hid": "i18n-alt-nl", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl" }, { "hid": "i18n-alt-nl-NL", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl-NL" }, { "hid": "i18n-alt-kr", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr" }, { "hid": "i18n-alt-kr-KO", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr-KO" }, { "hid": "i18n-xd", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "x-default" }, { "hid": "i18n-can", "rel": "canonical", "href": "/nuxt-context-extension" } ], "meta": [ { "hid": "i18n-og-url", "property": "og:url", "content": "/nuxt-context-extension" }, { "hid": "i18n-og", "property": "og:locale", "content": "en" }, { "hid": "i18n-og-alt-fr-FR", "property": "og:locale:alternate", "content": "fr_FR" }, { "hid": "i18n-og-alt-ja-JP", "property": "og:locale:alternate", "content": "ja_JP" }, { "hid": "i18n-og-alt-nl-NL", "property": "og:locale:alternate", "content": "nl_NL" }, { "hid": "i18n-og-alt-kr-KO", "property": "og:locale:alternate", "content": "kr_KO" } ] }"`


I'm not sure why this changed, I think the i18n-alt-fr-FR tag was added, shouldn't this have been there originally? 🤔

#locale-head value is injected by useHead. useHead parameters is specified by resolved with useLocaleHead

i18n/specs/fixtures/basic_usage/pages/index.vue

Lines 65 to 76 in 08638d7

const i18nHead = useLocaleHead({

addDirAttribute: true,

identifierAttribute: 'id',

addSeoAttributes: { canonicalQueries: ['page'] }

})

useHead({

htmlAttrs: {

lang: i18nHead.value.htmlAttrs!.lang

},

link: [...(i18nHead.value.link || [])],

meta: [...(i18nHead.value.meta || [])]

})

This chaning is affected by this PR, or maybe useLocaleHead has the issue. 🤔

I figured out why this happened and fixed it by moving the check/rename of the iso property (https://github.com/nuxt-modules/i18n/pull/3055/files#diff-39b2554fd18da165b59a6351b1aafff3714e2a80c1435f2de9706355b4d32351R518-R524) earlier in the code.

This is related to the way locales are normalized and merged if both string and object locales are configured in multiple layers. So the project layer had fr configured which was normalized to { code: 'fr', language: 'fr' } while a layer had configured { code: 'fr', iso: 'fr-FR' }, which is why both language tags ended up in the build.

kazupon

Thanks!
I've just reviewed your PR.
Please check it! 🙏

kazupon · 2024-08-10T14:28:41Z

docs/content/docs/5.v9/2.guide/18.breaking-changes-in-v9.md

+## Locale `iso` renamed to `language`
+
+The `iso` property on a locale object has been renamed to `language` as the original name refers to ISO standards which describe valid language tags.


We should add more explanation why we made this change, include PR link.
This would make it easier for users to understand.
#2449

kazupon · 2024-08-10T14:37:17Z

specs/basic_usage.spec.ts

@@ -141,7 +141,7 @@ describe('basic usage', async () => {
    )

    expect(await getText(page, '#locale-head')).toMatchInlineSnapshot(
-      `"{ "htmlAttrs": { "lang": "en" }, "link": [ { "hid": "i18n-alt-en", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "en" }, { "hid": "i18n-alt-fr", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr" }, { "hid": "i18n-alt-ja", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja" }, { "hid": "i18n-alt-ja-JP", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja-JP" }, { "hid": "i18n-alt-nl", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl" }, { "hid": "i18n-alt-nl-NL", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl-NL" }, { "hid": "i18n-alt-kr", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr" }, { "hid": "i18n-alt-kr-KO", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr-KO" }, { "hid": "i18n-xd", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "x-default" }, { "hid": "i18n-can", "rel": "canonical", "href": "/nuxt-context-extension" } ], "meta": [ { "hid": "i18n-og-url", "property": "og:url", "content": "/nuxt-context-extension" }, { "hid": "i18n-og", "property": "og:locale", "content": "en" }, { "hid": "i18n-og-alt-fr", "property": "og:locale:alternate", "content": "fr" }, { "hid": "i18n-og-alt-ja-JP", "property": "og:locale:alternate", "content": "ja_JP" }, { "hid": "i18n-og-alt-nl-NL", "property": "og:locale:alternate", "content": "nl_NL" }, { "hid": "i18n-og-alt-kr-KO", "property": "og:locale:alternate", "content": "kr_KO" } ] }"`
+      `"{ "htmlAttrs": { "lang": "en" }, "link": [ { "hid": "i18n-alt-en", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "en" }, { "hid": "i18n-alt-fr", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr" }, { "hid": "i18n-alt-fr-FR", "rel": "alternate", "href": "/fr/nuxt-context-extension", "hreflang": "fr-FR" }, { "hid": "i18n-alt-ja", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja" }, { "hid": "i18n-alt-ja-JP", "rel": "alternate", "href": "/ja/nuxt-context-extension", "hreflang": "ja-JP" }, { "hid": "i18n-alt-nl", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl" }, { "hid": "i18n-alt-nl-NL", "rel": "alternate", "href": "/nl/nuxt-context-extension", "hreflang": "nl-NL" }, { "hid": "i18n-alt-kr", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr" }, { "hid": "i18n-alt-kr-KO", "rel": "alternate", "href": "/kr/nuxt-context-extension", "hreflang": "kr-KO" }, { "hid": "i18n-xd", "rel": "alternate", "href": "/nuxt-context-extension", "hreflang": "x-default" }, { "hid": "i18n-can", "rel": "canonical", "href": "/nuxt-context-extension" } ], "meta": [ { "hid": "i18n-og-url", "property": "og:url", "content": "/nuxt-context-extension" }, { "hid": "i18n-og", "property": "og:locale", "content": "en" }, { "hid": "i18n-og-alt-fr-FR", "property": "og:locale:alternate", "content": "fr_FR" }, { "hid": "i18n-og-alt-ja-JP", "property": "og:locale:alternate", "content": "ja_JP" }, { "hid": "i18n-og-alt-nl-NL", "property": "og:locale:alternate", "content": "nl_NL" }, { "hid": "i18n-og-alt-kr-KO", "property": "og:locale:alternate", "content": "kr_KO" } ] }"`


#locale-head value is injected by useHead. useHead parameters is specified by resolved with useLocaleHead

i18n/specs/fixtures/basic_usage/pages/index.vue

Lines 65 to 76 in 08638d7

const i18nHead = useLocaleHead({

addDirAttribute: true,

identifierAttribute: 'id',

addSeoAttributes: { canonicalQueries: ['page'] }

})

useHead({

htmlAttrs: {

lang: i18nHead.value.htmlAttrs!.lang

},

link: [...(i18nHead.value.link || [])],

meta: [...(i18nHead.value.meta || [])]

})

This chaning is affected by this PR, or maybe useLocaleHead has the issue. 🤔

BobbieGoede · 2024-08-11T11:07:45Z

@kazupon
I made changes based on your feedback, let me know if anything needs to be changed!

kazupon

Good job!
Thank you! 💚

* fix: rename locale property `iso` to `language` * refactor: rename parameters * fix: locale `language` merging * docs: expand `iso` rename explanation

Adresses the change in nuxt-modules/i18n#3055

* chore(deps): update dependency @nuxtjs/i18n to v8.4.0 * Fixed renamed `iso`->`language` Adresses the change in nuxt-modules/i18n#3055 --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Frank Elsinga <frank@elsinga.de>

fix: rename locale property iso to language

a14b69c

BobbieGoede self-assigned this Aug 8, 2024

BobbieGoede commented Aug 8, 2024

View reviewed changes

BobbieGoede requested a review from kazupon August 8, 2024 19:06

kazupon requested changes Aug 10, 2024

View reviewed changes

BobbieGoede added 3 commits August 11, 2024 12:48

refactor: rename parameters

d94be05

fix: locale language merging

c8ad6fd

docs: expand iso rename explanation

68ad0fb

BobbieGoede requested a review from kazupon August 11, 2024 11:06

kazupon approved these changes Aug 11, 2024

View reviewed changes

kazupon merged commit 6a29add into nuxt-modules:main Aug 11, 2024
7 checks passed

BobbieGoede added a commit that referenced this pull request Aug 14, 2024

fix: rename locale iso property to language (#3055)

df93837

* fix: rename locale property `iso` to `language` * refactor: rename parameters * fix: locale `language` merging * docs: expand `iso` rename explanation

CommanderStorm added a commit to TUM-Dev/NavigaTUM that referenced this pull request Aug 15, 2024

Fixed renamed iso->language

7ccb7e6

Adresses the change in nuxt-modules/i18n#3055

reslear mentioned this pull request Aug 29, 2024

feat: refactor i18n v9 nuxt-modules/sitemap#350

Closed

KTrain5169 mentioned this pull request Oct 1, 2024

build(deps): bump @nuxtjs/i18n from 8.3.1 to 8.5.5 usevital/notessential#94

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: rename locale `iso` property to `language` #3055

fix: rename locale `iso` property to `language` #3055

BobbieGoede commented Aug 8, 2024

BobbieGoede Aug 8, 2024

kazupon Aug 10, 2024

BobbieGoede Aug 11, 2024

kazupon left a comment

kazupon Aug 10, 2024

kazupon Aug 10, 2024

BobbieGoede commented Aug 11, 2024

kazupon left a comment

	const i18nHead = useLocaleHead({
	addDirAttribute: true,
	identifierAttribute: 'id',
	addSeoAttributes: { canonicalQueries: ['page'] }
	})
	useHead({
	htmlAttrs: {
	lang: i18nHead.value.htmlAttrs!.lang
	},
	link: [...(i18nHead.value.link \|\| [])],
	meta: [...(i18nHead.value.meta \|\| [])]
	})

		## Locale `iso` renamed to `language`

		The `iso` property on a locale object has been renamed to `language` as the original name refers to ISO standards which describe valid language tags.

fix: rename locale iso property to language #3055

fix: rename locale iso property to language #3055

Conversation

BobbieGoede commented Aug 8, 2024

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

BobbieGoede Aug 8, 2024

Choose a reason for hiding this comment

kazupon Aug 10, 2024

Choose a reason for hiding this comment

BobbieGoede Aug 11, 2024

Choose a reason for hiding this comment

kazupon left a comment

Choose a reason for hiding this comment

kazupon Aug 10, 2024

Choose a reason for hiding this comment

kazupon Aug 10, 2024

Choose a reason for hiding this comment

BobbieGoede commented Aug 11, 2024

kazupon left a comment

Choose a reason for hiding this comment

fix: rename locale `iso` property to `language` #3055

fix: rename locale `iso` property to `language` #3055