8000
feat(l10n): upgrade `i18next-scanner` and refresh translations by cheton · Pull Request #884 · cncjs/cncjs · GitHub
More Web Proxy on the site http://driver.im/
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or 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
Here are some key observations to aid the review process:
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review
Configuration Change The removeUnusedKeys option has been changed from a boolean to a function. Verify that this change is intentional and does not break existing functionality.
New File A new file has been added to define supported languages. Ensure that all required languages are included and correctly configured.
Configuration Change Similar to the app config, the removeUnusedKeys option has been changed to a function. Verify consistency between app and server configurations.
Refine the condition for removing unused translation keys to prevent accidental removal of necessary keys
Consider using a more specific condition in the removeUnusedKeys function. The current implementation removes all keys in the 'resource' namespace, which might be too broad. You could add more specific conditions to ensure only truly unused keys are removed.
Why: The suggestion to refine the condition for removing unused keys by adding a check for key usage is valid and could prevent accidental removal of necessary keys. This enhances the functionality by ensuring only truly unused keys are removed, which is a meaningful improvement.
7
Maintainability
✅ Sort the supported languages array alphabetically for improved maintainability and readabilitySuggestion Impact:The suggestion to sort the supported languages array alphabetically by the label property was implemented, but with an additional condition to prioritize certain languages.
code diff:
+].sort((a, b) => {+ const bottomHalfLanguages = new Set(['ja', 'zh-cn', 'zh-tw']);++ const priorityA = bottomHalfLanguages.has(a.value) ? 1 : 0;+ const priorityB = bottomHalfLanguages.has(b.value) ? 1 : 0;++ // If both items are in the priority list, keep their original order+ if (priorityA === priorityB) {+ return a.label.localeCompare(b.label);+ }++ // If only one item is in the priority list, prioritize the other+ return priorityA - priorityB;
Consider sorting the SUPPORTED_LANGUAGES array alphabetically by the label property for easier maintenance and readability.
Why: Sorting the supported languages array alphabetically by the label property can improve readability and maintainability. However, it is a minor enhancement that does not affect functionality, hence a moderate score is appropriate.
Extract duplicate function to a shared utility file to reduce code duplication
Consider extracting the removeUnusedKeys function to a shared utility file, as it's identical in both 'app' and 'server' config files. This would improve maintainability and reduce code duplication.
Why: This suggestion is valid as it addresses code duplication by proposing to extract a common function into a utility file, which can improve maintainability and reduce redundancy.
7
Enhancement
✅ Use a configuration file for language options to improve maintainabilitySuggestion Impact:The commit implemented the suggestion by replacing hardcoded language options with a map function that iterates over a constant array, SUPPORTED_LANGUAGES, to generate the options dynamically.
Consider using a separate configuration file or a constant array to store language options, making it easier to maintain and update the list of supported languages.
Why: The suggestion to use a configuration file for language options is reasonable, as it can enhance maintainability by centralizing the language data. However, it is not critical and offers a moderate improvement.
✅ Improve consistency in language naming conventions
Consider using a consistent naming convention for country/language codes. 'Netherlands' should be 'Dutch' to match the language name pattern used for other entries.
Extract repeated function to improve code reusability
Consider extracting the removeUnusedKeys function to a separate utility file to promote code reusability, as it's used in multiple configuration files.
-"Are you sure you want to delete this item?": "Esta seguro de eliminar este ítem?",+"Are you sure you want to delete this item?": "¿Está seguro de eliminar este ítem?",
[Suggestion has been applied]
Suggestion importance[1-10]: 7
Why:
7
✅ Correct spelling errors in translations to improve accuracy
Use "más" instead of "mas" for correct spelling and meaning.
-"Are you sure you want to delete this item?": "Esta seguro de eliminar este ítem?",+"Are you sure you want to delete this item?": "¿Está seguro de eliminar este ítem?",
[Suggestion has been applied]
Suggestion importance[1-10]: 7
Why:
7
✅ Correct grammatical errors in Spanish translations to improve clarity
Use "ha" instead of "a" in the phrase "El servido a dejado de funcionar" for correct grammar.
✅ Provide translations for all UI elements to ensure a fully localized experience
The translation for "Fork Widget" is missing. Consider adding a Czech translation that conveys the meaning of forking a widget in the context of the application.
Why: Adding a translation for "Fork Widget" enhances the localization of the application, ensuring that all UI elements are accessible to Czech-speaking users. This is important for maintaining a consistent user experience.
8
Simplify conditional logic by directly returning the result of the comparison
Simplify the removeUnusedKeys function by directly returning the result of the comparison, eliminating the need for an if-else structure.
Why: Simplifying the function by directly returning the result of the comparison reduces code complexity and enhances readability, making the code more concise and easier to understand.
7
✅ Use more specific terminology for technical terms to improve clarity
Consider using a more specific term for "Command" in Czech. "Příkaz" can be ambiguous. For CNC context, "Instrukce" or "Povel" might be more appropriate.
Why: The suggestion to use "Instrukce" instead of "Příkaz" could improve clarity in the CNC context, as "Příkaz" can be ambiguous. This change enhances the precision of the translation, making it more contextually appropriate.
7
✅ Improve accuracy of technical translations to better convey functionality
The translation for "Keypad jogging" could be more precise. Consider using a term that specifically refers to machine control via keypad in Czech.
-"Keypad jogging": "Ovládání přes klávesnici",+"Keypad jogging": "Pohyb stroje klávesnicí",
[Suggestion has been applied]
Suggestion importance[1-10]: 7
Why: The suggestion to change "Ovládání přes klávesnici" to "Pohyb stroje klávesnicí" provides a more precise translation that better describes the functionality of controlling machine movement via a keypad, improving user understanding.
7
Best practice
Use more descriptive variable names to improve code readability
Consider using a more descriptive variable name instead of ns for clarity. For example, namespace would be more explicit.
Why: The suggestion to use a more descriptive variable name like 'namespace' instead of 'ns' improves code readability and clarity, which is beneficial for maintainability and understanding of the code.
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.
PR Type
enhancement, other
Description
i18next-scannerdependency to version 4.6.0.removeUnusedKeysfrom a boolean to a function in bothi18next-scannerapp and server configurations.Changes walkthrough 📝
2 files
i18next-scanner.app.config.js
Update `removeUnusedKeys` to a function in config.i18next-scanner.app.config.js
removeUnusedKeysfrom a boolean to a function.function.
i18next-scanner.server.config.js
Update `removeUnusedKeys` to a function in server config.i18next-scanner.server.config.js
removeUnusedKeysfrom a boolean to a function.function.
5 files
resource.json
Add and improve Russian translations.src/app/i18n/ru/resource.json
resource.json
Add and improve Czech translations.src/app/i18n/cs/resource.json
resource.json
Add and improve Ukrainian translations.src/app/i18n/uk/resource.json
resource.json
Add and improve Portuguese (Portugal) translations.src/app/i18n/pt-pt/resource.json
resource.json
Add and improve Japanese translations.src/app/i18n/ja/resource.json
10 files
resource.json
Complete Italian Translations for UI and System Messagessrc/app/i18n/it/resource.json
messages.
resource.json
Complete French Translations for UI and System Messagessrc/app/i18n/fr/resource.json
messages.
resource.json
Complete Turkish Translations for UI and System Messagessrc/app/i18n/tr/resource.json
messages.
resource.json
Complete Dutch Translations for UI and System Messagessrc/app/i18n/nl/resource.json
messages.
resource.json
Complete Norwegian Translations for UI and System Messagessrc/app/i18n/nb/resource.json
messages.
resource.json
Add English Strings for Data Collection and Language Settingssrc/app/i18n/en/resource.json
settings.
resource.json
Add missing Traditional Chinese translations for UI elements.src/app/i18n/zh-tw/resource.json
Chinese.
messages.
settings.
resource.json
Add missing Hungarian translations for UI elements.src/app/i18n/hu/resource.json
messages.
settings.
resource.json
Add missing Spanish translations for UI elements.src/app/i18n/es/resource.json
messages.
settings.
resource.json
Add missing Brazilian Portuguese translations for UI elements.src/app/i18n/pt-br/resource.json
Portuguese.
messages.
settings.
1 files
package.json
Upgrade `i18next-scanner` dependency to version 4.6.0.package.json
i18next-scannerdependency from version 4.5.0 to 4.6.0.2 files
resource.json
...src/app/i18n/de/resource.json
...
resource.json
...src/app/i18n/zh-cn/resource.json
...