[7472] Replace the term dependency with reference throughout the product #4900
Open
jvega190 wants to merge 2 commits into
Open
[7472] Replace the term dependency with reference throughout the product #4900jvega190 wants to merge 2 commits into
jvega190 wants to merge 2 commits into
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
WalkthroughReplaces all user-facing "dependencies", "dependants", and "dependent items" terminology with "references" across the UI. Changes affect tooltip labels, dialog titles and body text, context menu entries, translation keys, and i18n ChangesTerminology rename: dependencies → references
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 8
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
ui/app/src/components/DeletePluginDialog/UninstallPluginDialogBody.tsx (1)
85-89: 📐 Maintainability & Code Quality | 🟠 MajorI18n regression: Non-English translations will be lost.
The
FormattedMessagecomponent on line 85 uses onlydefaultMessageandvaluesprops, but lacks anidprop. Translation catalogs for Korean, Spanish, and German still defineuninstallPluginDialog.reviewDependenciesMessage, creating orphaned translations. Non-English users will see the EnglishdefaultMessageinstead of their localized text.Restore the
idprop to reference the catalog entry, or remove the orphaned keys from all translation files.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@ui/app/src/components/DeletePluginDialog/UninstallPluginDialogBody.tsx` around lines 85 - 89, The FormattedMessage component in UninstallPluginDialogBody.tsx that displays "Please review the items that reference the plugin..." is missing the id prop required to link it to the translation catalog. Add the id prop with value uninstallPluginDialog.reviewDependenciesMessage to the FormattedMessage component to ensure that the existing Korean, Spanish, and German translations are properly referenced instead of falling back to the English defaultMessage.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@ui/app/src/components/DeleteContentTypeDialog/DeleteContentTypeDialogBody.tsx`:
- Line 85: The FormattedMessage components in DeleteContentTypeDialogBody.tsx at
line 85 and lines 97-100 have had their id attributes removed, but the
translation catalogs still contain the corresponding keys
(deleteContentTypeDialog.reviewDependenciesMessage and
deleteContentTypeDialog.typeConfirmPassword). Without the id prop, react-intl
cannot match the components to their translations, causing non-English users to
see only the English defaultMessage. Restore the id attributes to both
FormattedMessage components with their original translation key names, or
alternatively remove these obsolete keys from the translation catalogs (de.json,
es.json, ko.json) if the ids were intentionally removed.
In `@ui/app/src/components/DeleteDialog/DeleteDialog.tsx`:
- Line 30: The FormattedMessage component in DeleteDialog.tsx that displays the
subtitle message (containing the text about selected items being deleted) is
missing the id attribute. This id attribute is required by react-intl to look up
translated messages from the translation catalogs. Restore the
id="deleteDialog.subtitle" attribute to the FormattedMessage component so that
non-English users will see their localized translations instead of only the
English defaultMessage.
In `@ui/app/src/components/DeleteDialog/DeleteDialogUIBody.tsx`:
- Around line 74-75: The FormattedMessage element displaying "Items that
reference the selected item" is missing its id attribute, which prevents the
i18n system from looking up translations in language catalogs and causes
non-English users to see only the English defaultMessage. Add back the id
attribute to this FormattedMessage element, using either the original
translation key deleteDialog.dependentItems if that key exists in all language
catalogs (ko.json, de.json, es.json, etc.), or create a new translation key for
the updated terminology and add corresponding translations to all language
catalog files to ensure the new phrasing is properly localized.
In `@ui/app/src/components/DependenciesDialog/DependenciesDialog.tsx`:
- Line 26: The FormattedMessage component used in the EnhancedDialog title prop
is missing the required id prop needed for react-intl translation lookup. Add
the id prop with value "dependenciesDialog.title" to the FormattedMessage
component alongside the existing defaultMessage prop. This will enable the
translation system to load the locale-specific translation key (such as the
German translation "Abhängigkeiten von Inhaltselementen" from de.json) instead
of always displaying the English default message. Ensure the id attribute
follows the same naming pattern as other FormattedMessage instances in the
component like dependenciesDialog.contentItems and dependenciesDialog.assets.
In `@ui/app/src/components/DependenciesDialog/DependenciesDialogUI.tsx`:
- Around line 115-122: The FormattedMessage components in
DependenciesDialogUI.tsx have commented-out id properties for the messages with
defaultMessage values "has no references" and "Nothing is referenced by". Remove
the commented-out ids and either add new appropriate id props (such as
"dependenciesDialog.noReferences" and "dependenciesDialog.noReferencedItems")
and update the corresponding locale files with translations, or restore the
original ids and update the locale file entries to use the new "references"
terminology instead of "dependants" and "dependencies". Ensure that the id
property is uncommented and active for both FormattedMessage components so that
internationalization works correctly for non-English users.
- Around line 96-99: The FormattedMessage components in the MenuItem elements
are missing explicit id props required for react-intl to perform locale-specific
translations. Add id props to each FormattedMessage component (e.g.,
id="dependenciesDialog.referencesOfSelectedItem" for the "References of selected
item" message and id="dependenciesDialog.referencedBySelectedItem" for the
"Items that are referenced by the selected item" message) to enable proper i18n
functionality, then update all locale translation files to include these new
message ids with appropriate translations for each language.
- Line 167: The FormattedMessage component in DependenciesDialogUI.tsx uses the
id "dependenciesDialog.references" which is missing from all locale translation
files. Add the key "dependenciesDialog.references" to each locale file (de.json,
es.json, and ko.json) with appropriate translations for each language. The
German translation should be something like "Verweise", Spanish should be
"Referencias", and Korean should be "참조" or similar localized equivalents. This
ensures non-English users see proper localized text instead of falling back to
the English "References" message.
In `@ui/app/src/components/DependenciesDialog/utils.tsx`:
- Line 82: The FormattedMessage component for the "Show all references" label is
missing the required id prop, which prevents react-intl from looking up
locale-specific translations for different languages. Add an id prop to the
FormattedMessage component (e.g., id="dependenciesDialog.showAllReferences") to
enable proper translation lookup, then update all locale files (such as de.json)
to include entries for this new id with appropriate translated text to replace
the outdated "dependenciesDialog.allDeps" entry.
---
Outside diff comments:
In `@ui/app/src/components/DeletePluginDialog/UninstallPluginDialogBody.tsx`:
- Around line 85-89: The FormattedMessage component in
UninstallPluginDialogBody.tsx that displays "Please review the items that
reference the plugin..." is missing the id prop required to link it to the
translation catalog. Add the id prop with value
uninstallPluginDialog.reviewDependenciesMessage to the FormattedMessage
component to ensure that the existing Korean, Spanish, and German translations
are properly referenced instead of falling back to the English defaultMessage.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 59c5874c-073a-45cf-b09f-906ee2acb94b
📒 Files selected for processing (18)
ui/app/src/components/ContentTypeManagement/controls/CopyDependencies.tsxui/app/src/components/ContentTypeManagement/controls/DeleteDependencies.tsxui/app/src/components/ContentTypeManagement/descriptors/controls/commonDescriptors.tsui/app/src/components/CreateFileDialog/translations.tsui/app/src/components/DeleteContentTypeDialog/DeleteContentTypeDialogBody.tsxui/app/src/components/DeleteDialog/DeleteDialog.tsxui/app/src/components/DeleteDialog/DeleteDialogUIBody.tsxui/app/src/components/DeletePluginDialog/UninstallPluginDialogBody.tsxui/app/src/components/DependenciesDialog/DependenciesDialog.tsxui/app/src/components/DependenciesDialog/DependenciesDialogUI.tsxui/app/src/components/DependenciesDialog/utils.tsxui/app/src/components/DependencySelection/DependencySelection.tsxui/app/src/components/ItemActionsMenu/translations.tsui/app/src/components/PublishOnDemandWidget/PublishOnDemandWidget.tsxui/app/src/components/RenameDialogBody/RenameItemView.tsxui/app/src/components/SiteConfigurationManagement/translations.tsui/app/src/env/i18n-legacy.tsui/app/src/utils/itemActions.ts
Member
Author
|
@coderabbitai can you check if everything looks good? Please give it a final review before I hand over for human review |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
echo "=== 1. Check for old i18n IDs that were removed but may still be referenced ==="
rg -n "dependenciesDialog\.title|deleteContentTypeDialog\.reviewDependenciesMessage|deleteContentTypeDialog\.typeConfirmPassword|uninstallPluginDialog\.reviewDependenciesMessage|words\.dependencies|dependentItems|renameAsset\.dependentItems|dependenciesDialog\.allDeps" --type ts --type tsx -g "*.tsx" -g "*.ts" .
echo ""
echo "=== 2. Check for remaining usages of translations.dependencies ==="
rg -n "translations\.dependencies" --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 3. Check for any remaining 'Dependent Items' or 'dependent items' text ==="
rg -n "Dependent [Ii]tems|dependent items|dependant items|dependant" --type ts -g "*.ts" -g "*.tsx" -g "*.json" .
echo ""
echo "=== 4. Check for any remaining 'dependencies' in defaultMessage strings ==="
rg -n 'defaultMessage.*[Dd]ependenc' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 5. Check for any remaining menu option label for 'dependencies' action ==="
rg -n '"dependencies"' --type ts -g "*.ts" -g "*.tsx" -C2 .
echo ""
echo "=== 6. Check DependenciesDialog component name still uses old naming ==="
rg -n "DependenciesDialog" --type ts -g "*.ts" -g "*.tsx" -l .
echo ""
echo "=== 7. Check for any remaining word 'Dependencies' in UI label context ==="
rg -n '"Dependencies"' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 8. Check DeleteDialog translations file for any leftover entries ==="
fd "translations.ts" --full-path -e ts | xargs grep -l "deleteDialog\|DeleteDialog" | head -5
echo ""
echo "=== 9. Check for the fetchingDependentItems ID usage ==="
rg -n "fetchingDependentItems" --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 10. Check DependencySelection component for remaining old IDs ==="
rg -n "dependencySelection\." --type ts -g "*.ts" -g "*.tsx" .Length of output: 8323
✅ What looks good
|
Member
Author
|
@CodeRabbit internally, we'll keep the old naming, so variables, components and comments may stay the same. Only user-facing text is going to be updated. Considering that, can you check if everything looks good? Please give it a final review before I hand over for human review |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
echo "=== 1. Remaining 'dependenc/dependant/dependent' in defaultMessage strings ==="
rg -n 'defaultMessage.*[Dd]ependenc|defaultMessage.*[Dd]ependant|defaultMessage.*[Dd]ependent' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 2. Remaining old terminology in aria-label strings ==="
rg -n 'aria-label.*[Dd]ependenc|aria-label.*[Dd]ependant|aria-label.*[Dd]ependent' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 3. Remaining old terminology in title/tooltip strings (JSX props) ==="
rg -n 'title=.*[Dd]ependenc|tooltip.*[Dd]ependenc' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 4. Check translations.ts files for any remaining 'dependency/dependencies' in defaultMessage ==="
fd "translations.ts" --full-path -e ts | xargs grep -n "ependenc\|ependant\|ependent" 2>/dev/null
echo ""
echo "=== 5. Check JSON locale/i18n files for any remaining old terminology ==="
fd -e json | xargs grep -l "ependenc\|ependant\|ependent" 2>/dev/null | head -20
echo ""
echo "=== 6. Check all FormattedMessage defaultMessage for remaining old text ==="
rg -n 'defaultMessage=.*[Dd]ependenc' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 7. Check for any label/button/menu text with old terminology ==="
rg -n '"[Dd]ependenc[a-z]* [A-Za-z]|[A-Za-z]* [Dd]ependenc' --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 8. Check for 'Dependency Resolver' remaining in user-facing text ==="
rg -n "Dependency Resolver" --type ts -g "*.ts" -g "*.tsx" .
echo ""
echo "=== 9. Check i18n-legacy.ts for any remaining user-facing 'dependencies' ==="
fd "i18n-legacy.ts" --full-path | xargs grep -n "ependenc" 2>/dev/nullLength of output: 16125
✅ All clear on user-facing text
📝 One minor follow-up to track (out of scope for this PR)The locale JSON files ( The PR is ready for human review. All user-visible text changes are complete and consistent. 🐇 ✏️ Learnings added
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
craftercms/craftercms#7472
Summary by CodeRabbit