Skip to content
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

fix: Translation fix for Left Drawer #2018

Merged
merged 2 commits into from
Jun 2, 2024

Conversation

pranshugupta54
Copy link
Member

@pranshugupta54 pranshugupta54 commented May 31, 2024

What kind of change does this PR introduce?

Translation fix

Issue Number:

Fixes #1925

Did you add tests for your changes?

NA

Snapshots/Videos:

image
image

If relevant, did you update the documentation?

NA

Summary

Fixed translation for left drawer by adding common translations and using the tCommon for rendering left drawer

Does this PR introduce a breaking change?

NA

Other information

NA

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features

    • Added multilingual support with translations for key terms in English, French, Hindi, Spanish, and Chinese.
    • Enhanced CollapsibleDropdown and LeftDrawerOrg components to support internationalization.
  • Tests

    • Updated CollapsibleDropdown tests to include internationalization support.

Copy link
Contributor

coderabbitai bot commented May 31, 2024

Walkthrough

The changes introduce internationalization support across various components by adding translations for multiple languages (French, Hindi, Spanish, and Chinese) in the common.json files. Additionally, the CollapsibleDropdown and LeftDrawerOrg components are updated to use the useTranslation hook from react-i18next to dynamically translate text based on the selected language. The updates ensure that the left drawer updates correctly when a new organization language is selected.

Changes

Files Change Summary
public/locales/en/common.json Added key-value pairs for various terms.
public/locales/fr/common.json Added French translations for various terms.
public/locales/hi/common.json Added Hindi translations for various terms.
public/locales/sp/common.json Added Spanish translations for various terms.
public/locales/zh/common.json Added Chinese translations for various terms.
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx Introduced useTranslation hook for dynamic text translation.
src/components/LeftDrawerOrg/LeftDrawerOrg.tsx Replaced static text with useTranslation hook for dynamic text translation.
src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx Added necessary imports and wrapped the component with providers for testing internationalization support.

Sequence Diagram(s) (Beta)

Silently ignored generating this section as the changes are mostly related to localization and minor enhancements.

Assessment against linked issues

Objective (Issue #1925) Addressed Explanation
Left drawer updates when a new organization language is selected
All tests must be valid and pass. They must test the fixing of this bug

Poem

In the code, translations bloom,
Languages dance from room to room.
With every click, a drawer aligns,
New words in place, how they shine!
A world now speaks in tongues so grand,
Thanks to the work of coder’s hand.
🌍💻✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@pranshugupta54 pranshugupta54 changed the title chore: Update common translations for multiple locales fix: Translation fix for Left Drawer May 31, 2024
@coderabbitai coderabbitai bot changed the title fix: Translation fix for Left Drawer chore: Update common translations for multiple locales May 31, 2024
@pranshugupta54 pranshugupta54 changed the title chore: Update common translations for multiple locales fix: Translation fix for Left Drawer May 31, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range and nitpick comments (6)
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (2)

Line range hint 24-24: Add setShowDropdown to the dependency array of useEffect to adhere to best practices.

-  }, [location.pathname]);
+  }, [location.pathname, setShowDropdown]);

Line range hint 57-89: Consider using optional chaining for safer access to properties.

-  subTargets.map(({ name, icon: stringIcon, url }, index) => {
+  subTargets?.map(({ name, icon: stringIcon, url }, index) => {
src/components/LeftDrawerOrg/LeftDrawerOrg.tsx (4)

Line range hint 93-93: Replace == with === for strict equality checks.

-  name == 'Membership Requests' ? 'Requests' : name
+  name === 'Membership Requests' ? 'Requests' : name

Also applies to: 146-146


Line range hint 109-109: Simplify alt text and avoid redundant words like "picture".

-  alt={`profile picture`}
+  alt={`profile`}

Line range hint 47-47: Add targets to the dependency array of useEffect to adhere to best practices.

-  }, [data]);
+  }, [data, targets]);

Line range hint 88-91: Add explicit type="button" to button elements to adhere to best practices.

-  <button
+  <button type="button"

Also applies to: 95-98, 106-106

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 37b4e1a and db1dda3.

Files selected for processing (7)
  • public/locales/en/common.json (1 hunks)
  • public/locales/fr/common.json (1 hunks)
  • public/locales/hi/common.json (1 hunks)
  • public/locales/sp/common.json (1 hunks)
  • public/locales/zh/common.json (1 hunks)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (4 hunks)
  • src/components/LeftDrawerOrg/LeftDrawerOrg.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • public/locales/fr/common.json
Additional context used
Biome
src/components/CollapsibleDropdown/CollapsibleDropdown.tsx

[error] 57-89: Change to an optional chain.


[error] 1-1: The default import is only used as a type.


[error] 24-24: This hook does not specify all of its dependencies: setShowDropdown

src/components/LeftDrawerOrg/LeftDrawerOrg.tsx

[error] 93-93: Use === instead of ==.
== is only allowed when comparing against null


[error] 109-109: Avoid the words "image", "picture", or "photo" in img element alt text.


[error] 109-109: Do not use template literals if interpolation and special-character handling are not needed.


[error] 146-146: Use === instead of ==.
== is only allowed when comparing against null


[error] 47-47: This hook does not specify all of its dependencies: targets


[error] 88-91: Provide an explicit type prop for the button element.


[error] 95-98: Provide an explicit type prop for the button element.


[error] 106-106: Provide an explicit type prop for the button element.

Additional comments not posted (7)
public/locales/zh/common.json (1)

51-64: Translations for new terms added correctly.

public/locales/en/common.json (1)

51-64: Translations for new terms added correctly.

public/locales/hi/common.json (1)

51-64: Translations for new terms added correctly.

public/locales/sp/common.json (1)

51-64: Translations for new terms added correctly.

src/components/CollapsibleDropdown/CollapsibleDropdown.tsx (2)

7-7: Import of useTranslation added correctly.


20-20: Ensure proper translation function usage.

Also applies to: 47-47, 77-77

src/components/LeftDrawerOrg/LeftDrawerOrg.tsx (1)

154-154: Ensure proper translation function usage.

coderabbitai[bot]
coderabbitai bot previously approved these changes May 31, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between db1dda3 and efad048.

Files selected for processing (1)
  • src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx (3 hunks)
Additional comments not posted (2)
src/components/CollapsibleDropdown/CollapsibleDropdown.test.tsx (2)

7-10: Imports for Redux and i18next are correctly added to support internationalization in tests.


48-52: The component is correctly wrapped with Provider and I18nextProvider to ensure proper state and internationalization context during testing.

Also applies to: 63-67

Copy link

codecov bot commented May 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.39%. Comparing base (37b4e1a) to head (efad048).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2018   +/-   ##
========================================
  Coverage    98.39%   98.39%           
========================================
  Files          210      210           
  Lines         5802     5804    +2     
  Branches      1711     1712    +1     
========================================
+ Hits          5709     5711    +2     
  Misses          87       87           
  Partials         6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@varshith257 varshith257 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to have translations to the left drawer too. Can you also add translation for file upload button as outlined in issue?

@pranshugupta54
Copy link
Member Author

Good to have translations to the left drawer too. Can you also add translation for file upload button as outlined in issue?

After exploring the web, I found that the "Choose File" and "No file chosen" text cannot be translated by our application. These strings are defined and translated by the browser itself, not by our application. This means their localization is managed by the browser, and we do not have control over their translation.

@palisadoes palisadoes merged commit cf57c47 into PalisadoesFoundation:develop Jun 2, 2024
12 checks passed
@pranshugupta54 pranshugupta54 deleted the fix-1925 branch June 3, 2024 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants