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

feat: added support for showing the default locale in the url #51

Conversation

Alexandre-Fernandez
Copy link
Contributor

  • added a property to the astro-i18next config showDefaultLocale, to set the behaviour of the routing concerning the default locale (localizePath & generate)
  • added a better way to use the astro-i18next config in the runtime (made the necessary modifications for the config's routes property to use this new way)

@Alexandre-Fernandez Alexandre-Fernandez force-pushed the feat/default-locale-prefix branch from a3bcda4 to 873e729 Compare October 11, 2022 07:59
@Alexandre-Fernandez Alexandre-Fernandez force-pushed the feat/default-locale-prefix branch from 873e729 to 5370983 Compare October 11, 2022 09:44
@yassinedoghri
Copy link
Owner

Hey, thanks for the PR!

Haven't checked it in details though, hard to find the time nowadays, I'll try reviewing it later. Though, if I understand correctly, this allows the default language to behave like other languages. So, for example if the default language is en, then it'll be set in both https://example.com/ and https://example.com/en, right? And also, why such a feature?

Having the astro-i18next config available at runtime is a nice touch 👍

@Alexandre-Fernandez
Copy link
Contributor Author

Alexandre-Fernandez commented Oct 11, 2022

So, for example if the default language is en, then it'll be set in both https://example.com/ and https://example.com/en

Yes, it makes the default locale behave like a normal one if the setting is turned on.

why such a feature?

  • This is a very common pattern for many websites
  • SEO
  • UX (user can directly replace the language code in the URL without getting a 404)
  • No favoritism (some countries have two or more languages, having a special treatment for one of them may not be wanted by the owners).
  • Consistency

Next.js i18n had a discussion about this if you're interested : vercel/next.js#18419

@yassinedoghri
Copy link
Owner

Thank you again for the PR, it's merged.

I'll have to clean things up in the develop branch and add a few notes in the docs before releasing. Currently busy on another project, hopefully I'll have time by the end of next week 🤞

@@ -0,0 +1,16 @@
import { AstroI18nextConfig } from "types";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be "./types". This is breaking the project for me right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for that one the auto-import messed up :/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I submitted a couple PRs to resolve this

yassinedoghri pushed a commit that referenced this pull request Nov 6, 2022
- default locale can now behave as other locales and be displayed in the url
- initialize astro-i18next config and to make it available at runtime

refs #54
yassinedoghri pushed a commit that referenced this pull request Nov 6, 2022
# [1.0.0-beta.13](v1.0.0-beta.12...v1.0.0-beta.13) (2022-11-06)

### Bug Fixes

* add isFileHidden function + tests to prevent missing hidden files ([7dcd0aa](7dcd0aa))
* **generate:** replace isLocale check with user defined locales to prevent nested folders generation ([a598e2e](a598e2e)), closes [#56](#56)
* **i18next-server:** load locale files synchronously ([e7892e2](e7892e2))
* update types import to relative ([#58](#58)) ([44a5422](44a5422))

### Features

* add option to show the default locale in the url ([#51](#51)) ([ea939db](ea939db)), closes [#54](#54)
* add support for route translations ([db5200b](db5200b)), closes [#50](#50) [#29](#29)
* allow implicit key for <Trans> when omitting i18nKey prop ([ff14354](ff14354)), closes [#53](#53)
* simplified API + instanciate i18next both in server and client side ([ed44510](ed44510)), closes [#57](#57) [#46](#46) [#37](#37)

### BREAKING CHANGES

* - defaultLanguage is now defaultLocale
- supportedLanguages is now locales
- i18next config is now split into two configs: `i18nextServer`
and `i18nextClient`
AliLee0923 pushed a commit to AliLee0923/astro-i18N that referenced this pull request Dec 2, 2023
# [1.0.0-beta.13](yassinedoghri/astro-i18next@v1.0.0-beta.12...v1.0.0-beta.13) (2022-11-06)

### Bug Fixes

* add isFileHidden function + tests to prevent missing hidden files ([7dcd0aa](yassinedoghri/astro-i18next@7dcd0aa))
* **generate:** replace isLocale check with user defined locales to prevent nested folders generation ([a598e2e](yassinedoghri/astro-i18next@a598e2e)), closes [#56](yassinedoghri/astro-i18next#56)
* **i18next-server:** load locale files synchronously ([e7892e2](yassinedoghri/astro-i18next@e7892e2))
* update types import to relative ([#58](yassinedoghri/astro-i18next#58)) ([44a5422](yassinedoghri/astro-i18next@44a5422))

### Features

* add option to show the default locale in the url ([#51](yassinedoghri/astro-i18next#51)) ([ea939db](yassinedoghri/astro-i18next@ea939db)), closes [#54](yassinedoghri/astro-i18next#54)
* add support for route translations ([db5200b](yassinedoghri/astro-i18next@db5200b)), closes [#50](yassinedoghri/astro-i18next#50) [#29](yassinedoghri/astro-i18next#29)
* allow implicit key for <Trans> when omitting i18nKey prop ([ff14354](yassinedoghri/astro-i18next@ff14354)), closes [#53](yassinedoghri/astro-i18next#53)
* simplified API + instanciate i18next both in server and client side ([ed44510](yassinedoghri/astro-i18next@ed44510)), closes [#57](yassinedoghri/astro-i18next#57) [#46](yassinedoghri/astro-i18next#46) [#37](yassinedoghri/astro-i18next#37)

### BREAKING CHANGES

* - defaultLanguage is now defaultLocale
- supportedLanguages is now locales
- i18next config is now split into two configs: `i18nextServer`
and `i18nextClient`
github-actions bot pushed a commit to jeffwcx/astro-i18next that referenced this pull request Dec 4, 2024
# 1.0.0 (2024-12-04)

### Bug Fixes

* add depth level to relative import declarations ([02ddb76](02ddb76))
* add isFileHidden function + tests to prevent missing hidden files ([7dcd0aa](7dcd0aa))
* add levels to Astro.global pattern and scripts' import statements ([9d88d79](9d88d79))
* add levels to relative path in script tag ([1203d42](1203d42)), closes [yassinedoghri#129](https://github.com/jeffwcx/astro-i18next/issues/129)
* add missing `script` to regex in resolveRelativePathsLevel ([9288efe](9288efe)), closes [yassinedoghri#129](https://github.com/jeffwcx/astro-i18next/issues/129)
* **build:** remove components and utils from build + set components export to src ([bb7ab0f](bb7ab0f)), closes [yassinedoghri#18](https://github.com/jeffwcx/astro-i18next/issues/18)
* **cli:** filter out any file other than .astro files for generate ([c34fa07](c34fa07))
* **example:** add isCurrentPath function comparing current url to localized path ([ee90afb](ee90afb))
* expect locales folder to be in astro's publicDir config by default ([ec72ff3](ec72ff3)), closes [yassinedoghri#64](https://github.com/jeffwcx/astro-i18next/issues/64)
* **generate:** ignore any directories/files that begin with an underscore ([a7e6f08](a7e6f08)), closes [yassinedoghri#43](https://github.com/jeffwcx/astro-i18next/issues/43)
* **generate:** inject changeLanguage statement after imports and before frontmatter logic ([4d74e0b](4d74e0b)), closes [yassinedoghri#23](https://github.com/jeffwcx/astro-i18next/issues/23)
* **generate:** replace isLocale check with user defined locales to prevent nested folders generation ([a598e2e](a598e2e)), closes [yassinedoghri#56](https://github.com/jeffwcx/astro-i18next/issues/56)
* get astro pages' full paths using fdir's withFullPaths instead of withRelativePaths ([92a5178](92a5178)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* handle localizePath trailing slash depending on astro's trailingSlash config ([880666c](880666c)), closes [yassinedoghri#119](https://github.com/jeffwcx/astro-i18next/issues/119)
* **i18next-server:** load locale files synchronously ([e7892e2](e7892e2))
* import localizeUrl in HeadHrefLangs from index for access to astro-i18next runtime config ([5e3b96c](5e3b96c)), closes [yassinedoghri#65](https://github.com/jeffwcx/astro-i18next/issues/65)
* include LanguageSelector component to release files ([efa1961](efa1961))
* **language-selector:** replace country-code-to-flag-emoji dependency with locale-emoji ([6aee21d](6aee21d)), closes [yassinedoghri#14](https://github.com/jeffwcx/astro-i18next/issues/14)
* **plugins:** normalize named imports to call in i18next's use function ([6928ddc](6928ddc)), closes [yassinedoghri#38](https://github.com/jeffwcx/astro-i18next/issues/38)
* remove trailing slash from localized path ([1998309](1998309)), closes [yassinedoghri#77](https://github.com/jeffwcx/astro-i18next/issues/77)
* replace @proload/plugin-typescript with @proload/plugin-tsm ([6f639ee](6f639ee))
* replace language-flag-colors with country-code-to-flag-emoji dependency ([7d4d408](7d4d408))
* reset iso-639-1 and locale-emoji as dependencies ([b2863d7](b2863d7)), closes [yassinedoghri#32](https://github.com/jeffwcx/astro-i18next/issues/32)
* resolve astroFileFullPath to extract relative astroFilePath on Windows ([c23cd27](c23cd27)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* Rollup failed to resolve import 'types' ([yassinedoghri#33](https://github.com/jeffwcx/astro-i18next/issues/33)) ([2807989](2807989))
* take astro base path into account when using localizePath or localizeUrl functions ([5c35eaf](5c35eaf)), closes [yassinedoghri#27](https://github.com/jeffwcx/astro-i18next/issues/27)
* **trans component:** import utility functions from index ([eea0d5d](eea0d5d))
* type definitions for exported astro components ([bb60949](bb60949)), closes [yassinedoghri#18](https://github.com/jeffwcx/astro-i18next/issues/18)
* update package.json's exports value ([86d7cf9](86d7cf9))
* update publish workflow to include bundled package in dist ([5428dc3](5428dc3))
* update types import to relative ([yassinedoghri#58](https://github.com/jeffwcx/astro-i18next/issues/58)) ([44a5422](44a5422))
* update utils path to relative in Trans component ([c767fe3](c767fe3))
* use fileURLToPath to normalize publicDir pathname accross operating systems ([3c07d6a](3c07d6a)), closes [yassinedoghri#79](https://github.com/jeffwcx/astro-i18next/issues/79)
* use unjs/pathe to resolve cross OS public path ([ad1d24f](ad1d24f)), closes [yassinedoghri#105](https://github.com/jeffwcx/astro-i18next/issues/105)
* use unjs/pathe to resolve generated localized files paths across OS ([da80a8d](da80a8d)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* **workflow:** download bundle artifact into dist path to include it into package ([3fb5a78](3fb5a78))

### Features

* add astro integration --> initialize i18next upon astro:config:setup ([78ec744](78ec744))
* add HeadHrefLangs component + localizeUrl util function ([cd4095e](cd4095e))
* add i18next namespaces + validate config before processing it ([10b40cc](10b40cc))
* add LanguageSelector component to select language from supported locales ([ad3fe2a](ad3fe2a))
* add option to show the default locale in the url ([yassinedoghri#51](https://github.com/jeffwcx/astro-i18next/issues/51)) ([ea939db](ea939db)), closes [yassinedoghri#54](https://github.com/jeffwcx/astro-i18next/issues/54)
* add showFlag attribute to LanguageSelector to display the flag emoji or not ([a4b2f98](a4b2f98))
* add support for route translations ([db5200b](db5200b)), closes [yassinedoghri#50](https://github.com/jeffwcx/astro-i18next/issues/50) [yassinedoghri#29](https://github.com/jeffwcx/astro-i18next/issues/29)
* add Trans component to interpolate translation strings with its contents ([14ff1bd](14ff1bd))
* add utility function to localize path + improve components and overall DX ([d230f00](d230f00))
* Allow astro versions greater than 1.0.0 as peer dependency. ([0205d41](0205d41))
* allow implicit key for <Trans> when omitting i18nKey prop ([ff14354](ff14354)), closes [yassinedoghri#53](https://github.com/jeffwcx/astro-i18next/issues/53)
* allow passing functions to i18next init ([ed7c721](ed7c721))
* allow using i18next plugins directly in the config ([114ccd7](114ccd7))
* **cli:** add generate command to create localized astro pages ([17982cf](17982cf)), closes [yassinedoghri#13](https://github.com/jeffwcx/astro-i18next/issues/13)
* **cli:** add success feedback to generate command + add generated filepaths with verbose ([9e3d4f5](9e3d4f5))
* **language-selector:** add languageMapping prop to rename languages of choice ([20d94e4](20d94e4)), closes [yassinedoghri#116](https://github.com/jeffwcx/astro-i18next/issues/116)
* load translation resources automatically + add example website ([48dd98e](48dd98e))
* make base path for i18next resources configurable ([4e4b057](4e4b057))
* move astro-i18next config in a standalone file to load it for CLI commands ([bdf2408](bdf2408))
* **plugins:** set i18next plugins config for both server and client side setups ([5ddb1c7](5ddb1c7)), closes [yassinedoghri#68](https://github.com/jeffwcx/astro-i18next/issues/68)
* prefix language name with language flag emoji using language-flag-colors ([7e09d93](7e09d93))
* simplified API + instanciate i18next both in server and client side ([ed44510](ed44510)), closes [yassinedoghri#57](https://github.com/jeffwcx/astro-i18next/issues/57) [yassinedoghri#46](https://github.com/jeffwcx/astro-i18next/issues/46) [yassinedoghri#37](https://github.com/jeffwcx/astro-i18next/issues/37)

### Reverts

* **i18next-peer:** reset i18next as package dependency ([7906e19](7906e19)), closes [yassinedoghri#131](https://github.com/jeffwcx/astro-i18next/issues/131)

### BREAKING CHANGES

* - defaultLanguage is now defaultLocale
- supportedLanguages is now locales
- i18next config is now split into two configs: `i18nextServer`
and `i18nextClient`
* config is now a standalone file + some property names
have changed for better clarity and consistency

- `baseLocale` is now `defaultLanguage`
- `supportedLocales` is now `supportedLanguages``
* `baseLanguage` is now `baseLocale` in config options
* rename i18nextConfig to i18next in config + remove className and baseLanguage props
for LanguageSelector
github-actions bot pushed a commit to jeffwcx/astro-i18next that referenced this pull request Dec 4, 2024
# 1.0.0-beta.1 (2024-12-04)

### Bug Fixes

* add depth level to relative import declarations ([02ddb76](02ddb76))
* add isFileHidden function + tests to prevent missing hidden files ([7dcd0aa](7dcd0aa))
* add levels to Astro.global pattern and scripts' import statements ([9d88d79](9d88d79))
* add levels to relative path in script tag ([1203d42](1203d42)), closes [yassinedoghri#129](https://github.com/jeffwcx/astro-i18next/issues/129)
* add missing `script` to regex in resolveRelativePathsLevel ([9288efe](9288efe)), closes [yassinedoghri#129](https://github.com/jeffwcx/astro-i18next/issues/129)
* **build:** remove components and utils from build + set components export to src ([bb7ab0f](bb7ab0f)), closes [yassinedoghri#18](https://github.com/jeffwcx/astro-i18next/issues/18)
* **cli:** filter out any file other than .astro files for generate ([c34fa07](c34fa07))
* **example:** add isCurrentPath function comparing current url to localized path ([ee90afb](ee90afb))
* expect locales folder to be in astro's publicDir config by default ([ec72ff3](ec72ff3)), closes [yassinedoghri#64](https://github.com/jeffwcx/astro-i18next/issues/64)
* **generate:** ignore any directories/files that begin with an underscore ([a7e6f08](a7e6f08)), closes [yassinedoghri#43](https://github.com/jeffwcx/astro-i18next/issues/43)
* **generate:** inject changeLanguage statement after imports and before frontmatter logic ([4d74e0b](4d74e0b)), closes [yassinedoghri#23](https://github.com/jeffwcx/astro-i18next/issues/23)
* **generate:** replace isLocale check with user defined locales to prevent nested folders generation ([a598e2e](a598e2e)), closes [yassinedoghri#56](https://github.com/jeffwcx/astro-i18next/issues/56)
* get astro pages' full paths using fdir's withFullPaths instead of withRelativePaths ([92a5178](92a5178)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* handle localizePath trailing slash depending on astro's trailingSlash config ([880666c](880666c)), closes [yassinedoghri#119](https://github.com/jeffwcx/astro-i18next/issues/119)
* **i18next-server:** load locale files synchronously ([e7892e2](e7892e2))
* import localizeUrl in HeadHrefLangs from index for access to astro-i18next runtime config ([5e3b96c](5e3b96c)), closes [yassinedoghri#65](https://github.com/jeffwcx/astro-i18next/issues/65)
* include LanguageSelector component to release files ([efa1961](efa1961))
* **language-selector:** replace country-code-to-flag-emoji dependency with locale-emoji ([6aee21d](6aee21d)), closes [yassinedoghri#14](https://github.com/jeffwcx/astro-i18next/issues/14)
* **plugins:** normalize named imports to call in i18next's use function ([6928ddc](6928ddc)), closes [yassinedoghri#38](https://github.com/jeffwcx/astro-i18next/issues/38)
* remove trailing slash from localized path ([1998309](1998309)), closes [yassinedoghri#77](https://github.com/jeffwcx/astro-i18next/issues/77)
* replace @proload/plugin-typescript with @proload/plugin-tsm ([6f639ee](6f639ee))
* replace language-flag-colors with country-code-to-flag-emoji dependency ([7d4d408](7d4d408))
* reset iso-639-1 and locale-emoji as dependencies ([b2863d7](b2863d7)), closes [yassinedoghri#32](https://github.com/jeffwcx/astro-i18next/issues/32)
* resolve astroFileFullPath to extract relative astroFilePath on Windows ([c23cd27](c23cd27)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* Rollup failed to resolve import 'types' ([yassinedoghri#33](https://github.com/jeffwcx/astro-i18next/issues/33)) ([2807989](2807989))
* take astro base path into account when using localizePath or localizeUrl functions ([5c35eaf](5c35eaf)), closes [yassinedoghri#27](https://github.com/jeffwcx/astro-i18next/issues/27)
* **trans component:** import utility functions from index ([eea0d5d](eea0d5d))
* type definitions for exported astro components ([bb60949](bb60949)), closes [yassinedoghri#18](https://github.com/jeffwcx/astro-i18next/issues/18)
* update package.json's exports value ([86d7cf9](86d7cf9))
* update publish workflow to include bundled package in dist ([5428dc3](5428dc3))
* update types import to relative ([yassinedoghri#58](https://github.com/jeffwcx/astro-i18next/issues/58)) ([44a5422](44a5422))
* update utils path to relative in Trans component ([c767fe3](c767fe3))
* use fileURLToPath to normalize publicDir pathname accross operating systems ([3c07d6a](3c07d6a)), closes [yassinedoghri#79](https://github.com/jeffwcx/astro-i18next/issues/79)
* use unjs/pathe to resolve cross OS public path ([ad1d24f](ad1d24f)), closes [yassinedoghri#105](https://github.com/jeffwcx/astro-i18next/issues/105)
* use unjs/pathe to resolve generated localized files paths across OS ([da80a8d](da80a8d)), closes [yassinedoghri#135](https://github.com/jeffwcx/astro-i18next/issues/135)
* **workflow:** download bundle artifact into dist path to include it into package ([3fb5a78](3fb5a78))

### Features

* add astro integration --> initialize i18next upon astro:config:setup ([78ec744](78ec744))
* add HeadHrefLangs component + localizeUrl util function ([cd4095e](cd4095e))
* add i18next namespaces + validate config before processing it ([10b40cc](10b40cc))
* add LanguageSelector component to select language from supported locales ([ad3fe2a](ad3fe2a))
* add option to show the default locale in the url ([yassinedoghri#51](https://github.com/jeffwcx/astro-i18next/issues/51)) ([ea939db](ea939db)), closes [yassinedoghri#54](https://github.com/jeffwcx/astro-i18next/issues/54)
* add showFlag attribute to LanguageSelector to display the flag emoji or not ([a4b2f98](a4b2f98))
* add support for route translations ([db5200b](db5200b)), closes [yassinedoghri#50](https://github.com/jeffwcx/astro-i18next/issues/50) [yassinedoghri#29](https://github.com/jeffwcx/astro-i18next/issues/29)
* add Trans component to interpolate translation strings with its contents ([14ff1bd](14ff1bd))
* add utility function to localize path + improve components and overall DX ([d230f00](d230f00))
* Allow astro versions greater than 1.0.0 as peer dependency. ([0205d41](0205d41))
* allow implicit key for <Trans> when omitting i18nKey prop ([ff14354](ff14354)), closes [yassinedoghri#53](https://github.com/jeffwcx/astro-i18next/issues/53)
* allow passing functions to i18next init ([ed7c721](ed7c721))
* allow using i18next plugins directly in the config ([114ccd7](114ccd7))
* **cli:** add generate command to create localized astro pages ([17982cf](17982cf)), closes [yassinedoghri#13](https://github.com/jeffwcx/astro-i18next/issues/13)
* **cli:** add success feedback to generate command + add generated filepaths with verbose ([9e3d4f5](9e3d4f5))
* **language-selector:** add languageMapping prop to rename languages of choice ([20d94e4](20d94e4)), closes [yassinedoghri#116](https://github.com/jeffwcx/astro-i18next/issues/116)
* load translation resources automatically + add example website ([48dd98e](48dd98e))
* make base path for i18next resources configurable ([4e4b057](4e4b057))
* move astro-i18next config in a standalone file to load it for CLI commands ([bdf2408](bdf2408))
* **plugins:** set i18next plugins config for both server and client side setups ([5ddb1c7](5ddb1c7)), closes [yassinedoghri#68](https://github.com/jeffwcx/astro-i18next/issues/68)
* prefix language name with language flag emoji using language-flag-colors ([7e09d93](7e09d93))
* simplified API + instanciate i18next both in server and client side ([ed44510](ed44510)), closes [yassinedoghri#57](https://github.com/jeffwcx/astro-i18next/issues/57) [yassinedoghri#46](https://github.com/jeffwcx/astro-i18next/issues/46) [yassinedoghri#37](https://github.com/jeffwcx/astro-i18next/issues/37)

### Reverts

* **i18next-peer:** reset i18next as package dependency ([7906e19](7906e19)), closes [yassinedoghri#131](https://github.com/jeffwcx/astro-i18next/issues/131)

### BREAKING CHANGES

* - defaultLanguage is now defaultLocale
- supportedLanguages is now locales
- i18next config is now split into two configs: `i18nextServer`
and `i18nextClient`
* config is now a standalone file + some property names
have changed for better clarity and consistency

- `baseLocale` is now `defaultLanguage`
- `supportedLocales` is now `supportedLanguages``
* `baseLanguage` is now `baseLocale` in config options
* rename i18nextConfig to i18next in config + remove className and baseLanguage props
for LanguageSelector
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants