-
Notifications
You must be signed in to change notification settings - Fork 180
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
Integrate @formatjs/intl
as a replacement for t()
#7296
Merged
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
parlt91
approved these changes
Jul 25, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really valuable addition. TYVM
See two really small remarks below
nodeg
pushed a commit
to nodeg/uyuni
that referenced
this pull request
Aug 4, 2023
…7296) * Initial implementation * Update docs * Test global binding * Cleanup * Update translations to new format * Upgrade more translations * Update more translations * Add tests, clean up * Deprecate test-utils t() * Update licenses * Cleanup * Update commentary * Fix pagination translation * Refactor preferred locale * Cleanup * Add changes * Cleanup
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.
What does this PR change?
Our current translation wrapper
t()
is a simple hand-rolled solution that works for basic translation, but notably does not support translations with DOM nodes mixed in etc. This PR integrates@formatjs/intl
as a near drop-in replacement to add support for the missing functionality and simplify many of our existing translations.@formatjs/intl
, the library internally used byreact-intl
, was picked over a vanillareact-intl
setup to accommodate for our SPA architecture aroundsenna
which makes it difficult to use global wrappers such as intl providers. If we ever dropsenna
, we can easily swap out@formatjs/intl
forreact-intl
.Notable changes:
No more numeric replacements, all replacements must now be named.
Before:
After:
Support for mixing DOM and React components into translations has been added, meaning no more chopped up translations.
Before:
After:
GUI diff
No difference.
Documentation
No documentation needed: only internal and user invisible changes
DONE
Test coverage
Unit tests were added
DONE
Links
Fixes https://github.com/SUSE/spacewalk/issues/20449
Tracks https://github.com/SUSE/spacewalk/issues/21208
Changelogs
Make sure the changelogs entries you are adding are compliant with https://github.com/uyuni-project/uyuni/wiki/Contributing#changelogs and https://github.com/uyuni-project/uyuni/wiki/Contributing#uyuni-projectuyuni-repository
If you don't need a changelog check, please mark this checkbox:
If you uncheck the checkbox after the PR is created, you will need to re-run
changelog_test
(see below)Re-run a test
If you need to re-run a test, please mark the related checkbox, it will be unchecked automatically once it has re-run: