!!!FEATURE: Reform i18n mechanism #3804
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grebaldi
force-pushed
the
task/centralize-i18n
branch
2 times, most recently
from
33fb626 to
232e6a8
Compare
grebaldi
changed the title
|
I like this, but wow it's also A LOT. Thanks for digging in! |
markusguenther
force-pushed
the
task/centralize-i18n
branch
2 times, most recently
from
894dbeb to
4d4bf35
Compare
|
Rebased to latest 9.0 state. |
|
Locally the e2e tests run fine: |
markusguenther
force-pushed
the
task/centralize-i18n
branch
from
4d4bf35 to
9b1bddb
Compare
markusguenther
force-pushed
the
task/centralize-i18n
branch
from
9b1bddb to
395502a
Compare
mhsdesign
approved these changes
Jan 14, 2025
There was a problem hiding this comment.
Thank you so much for refactoring the translation functionality.
When reading the code i really enjoyed finding common modern php patterns now reflected here in the code base like immutable value objects, collection of vo's, enums, explicit exceptions, etc (and also repositories) while on the other hand embracing functions when applicable like the main translation function which is just that - a function - not a service, registry or anything which is quite how javascript was indented. I think this unique mix is a really good pattern for the future and this example i18n implementation gives a good boilerplate for future similar endpoints or functionality.
For a moment i was wondering if we had to respect the Neos.Neos.userInterface.scrambleTranslatedLabels option but funnily this is sorely handled by the XliffService and thus the rendered json will already be containing the ####### scrambles.
Soo much work and a well designed model :D Thanks!
packages/neos-ui-i18n/README.md
Outdated
There was a problem hiding this comment.
lovely inline documentation thanks ❤️ !11!!!
| teardownI18n(); | ||
| }); | ||
|
|
||
| it('loads the translation from the location specified in the current HTML document', async () => { |
| } | ||
| } | ||
|
|
||
| export class InvalidLocale extends Error { |
There was a problem hiding this comment.
i like that you adapted the php code style regarding exceptions with factory methods like InvalidLocale.becauseOfInvalidIdentifier() as proposed and used in the ESCR https://discuss.neos.io/t/rfc-updated-default-code-style/5836!!
Comment on lines
+13
to
+23
| export class Locale { | ||
| private readonly intlPluralRules: Intl.PluralRules; | ||
|
|
||
| private constructor( | ||
| private readonly intlLocale: Intl.Locale, | ||
| private readonly pluralRules: PluralRules | ||
| ) { | ||
| this.intlPluralRules = new Intl.PluralRules(this.intlLocale.toString()); | ||
| } | ||
|
|
||
| public static create = (identifier: string, pluralRulesAsString: string): Locale => { |
There was a problem hiding this comment.
this is basically how we write value objects in php too !!! this is a great direction :D
markusguenther
approved these changes
Jan 14, 2025
Removes the underscore for clarity and modern style.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
prelude to: #3773
refs: #3119
This PR reforms the UI's i18n mechanism by exposing a new function
translatedirectly from the@neos-project/neos-ui-i18npackage.The function looks as follows:
And can be used like this:
The new mechanism is completely independent from registries. There's no longer a need for injecting the
I18nRegistryto use translations, insteadtranslatecan be used directly.translatewill only work after the translations have been loaded during the bootstrapping process of@neos-project/neos-ui. If it is used too early, it throws an exception.The function now also properly supports plural rules (via
IntlWeb API). ThaI18nRegistryhad only supported English plurals, but with broken rules (quantity=0 yielded singular instead of plural).Other changes included in this PR are:
@neos-project/neos-ui-i18nis now TypeScript (savemanifest.js)<I18n/>-component was deprecatedI18nRegistryis now properly documented, but was also deprecatedxliff.jsonendpoint is now discovered via<link>-tag, instead of initial data<link>-tag is marked withprefetchto slightly speed up the fetch request@neos-project/neos-ui-i18nnow has a comprehensive README.mdThis change is breaking, because translations may have relied on the broken plural rules. It is also breaking, because the signature for substitution parameters has changed slightly - although this should be non-breaking at runtime.