-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
🔄 chore: Enforce 18next Language Keys #5803
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
🚨 Unused i18next Keys DetectedThe following translation keys are defined in
|
danny-avila
approved these changes
Feb 12, 2025
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.
Summary
This PR updates and refines the project’s translation and localization system to enforce stricter type safety and consistency across the codebase. The key changes include:
i18next Type Improvements:
client/src/@types/i18next.d.ts
to define theCustomTypeOptions
withdefaultNS
,resources
, and enablingstrictKeyChecks
.TranslationKeys
) are used in the project.Refactoring Translation Key Usages:
TranslationKeys
type.useLocalize
) so that translation keys are now strongly typed and validated at compile time.Workflow and ESLint Updates:
.github/workflows/i18n-unused-keys.yml
) to format the output as checkboxes, making it easier for manual checks.eslint.config.mjs
) to reflect the new i18next rules and ensure that literal strings are not used where translation keys are expected.Additional Minor Changes:
.gitignore
, package configuration files, and various UI components (e.g., dynamic inputs, dropdowns, switches, and textareas) to support the new translation typing.TranslationKeys
types.Change Type
Testing
To verify these changes:
Local Testing:
Linting & Type Checking:
TranslationKeys
type.CI/CD Verification:
Checklist