Plant-for-the-Planet-org / planet-webapp

The Open Source and Commission Free Application that powers the Trillion Tree Campaign. Visit us to meet reforestation Organizations, individuals and companies who are on a journey to plant, monitor and restore a trillion trees.
https://www.trilliontreecampaign.org
Other
37 stars 15 forks source link

Add missing translations #2231

Closed mohitb35 closed 2 months ago

mohitb35 commented 2 months ago
  1. Adds missing static translations to the codebase (i.e. translations where the keys are static and not dependent on dynamic data) and corrects incorrect translation keys.
  2. Resolves minor warning for translated text based on unitTypeOptions (src/features/user/ManageProjects/components/BasicDetails.tsx)
  3. Sets up a VS code task to identify missing translation keys across the codebase. tasks.json is committed to the repo to make this accessible to the team.
vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
planet-webapp-multi-tenancy-setup ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 10:49am
2 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **planet-webapp** | ⬜️ Ignored ([Inspect](https://vercel.com/planetapp/planet-webapp/9y2hZ4So3Fs7QPhU4T6xVSAhPV1s)) | | | Sep 16, 2024 10:49am | | **planet-webapp-temp** | ⬜️ Ignored ([Inspect](https://vercel.com/planetapp/planet-webapp-temp/9mAEJj6ur6XMxcgtgm6XkWhAC5S4)) | | | Sep 16, 2024 10:49am |
coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces several updates across multiple files. The .gitignore file has been enhanced to exclude additional configuration and environment files. A new task for TypeScript compilation checks has been added in the .vscode/tasks.json. Minor modifications were made to a message key in the RedeemCode component, and the unitTypeOptions constant in the BasicDetails component was updated to improve type safety using TypeScript's as const assertion.

Changes

File Path Change Summary
.gitignore Added entries for .vscode/settings.json, .vscode/launch.json, .env copy.local, and tsconfig.tsbuildinfo.
.vscode/tasks.json Added a new task labeled "TypeScript: Check MessageKeys errors" for type checking with tsc.
pages/sites/[slug]/[locale]/profile/redeem/[code].tsx Modified message key from t('redeem:selfGiftMessage') to t('selfGiftMessage').
src/features/user/ManageProjects/components/BasicDetails.tsx Changed unitTypeOptions declaration to use as const for enhanced type safety.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant VSCode
    participant TypeScript

    Developer->>VSCode: Execute "TypeScript: Check MessageKeys errors"
    VSCode->>TypeScript: Run `npx tsc --noEmit --pretty`
    TypeScript-->>VSCode: Return type check results
    VSCode-->>Developer: Display filtered output

Poem

🐇 In the garden of code, we hop and play,
With .gitignore keeping clutter at bay.
A task for TypeScript, oh what a delight,
Errors caught swiftly, everything feels right!
With keys now simplified, our paths are clear,
Hopping through changes, we celebrate here! 🎉


Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 409fdfa8916c8f62ba176ef94e0e02f10873a25f and 921b1c6039f5a73e7c707e105ecfc73e50891f0b.
Files ignored due to path filters (1) * `public/static/locales/en/me.json` is excluded by `!**/*.json`
Files selected for processing (4) * .gitignore (1 hunks) * .vscode/tasks.json (1 hunks) * pages/sites/[slug]/[locale]/profile/redeem/[code].tsx (1 hunks) * src/features/user/ManageProjects/components/BasicDetails.tsx (1 hunks)
Files skipped from review due to trivial changes (3) * .gitignore * pages/sites/[slug]/[locale]/profile/redeem/[code].tsx * src/features/user/ManageProjects/components/BasicDetails.tsx
Additional comments not posted (1)
.vscode/tasks.json (1)
`1-17`: **LGTM!** The TypeScript task configuration is well-defined and serves a useful purpose in the development workflow. It provides an efficient way to identify and address specific type errors related to `MessageKeys`. The task: - Correctly invokes the TypeScript compiler with appropriate flags - Filters the output to focus on the relevant error messages - Presents the results in a clear and accessible manner This task can help developers catch and fix type errors early in the development process, improving code quality and maintainability.
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , please review it.` -- `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 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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mohitb35 commented 2 months ago

Those errors will be fixed separately. For now, we've fixed errors where the keys were known (more or less static).

In many of the other cases, the keys are dynamic and we need to update or set up types and type checks to handle them.

Plan to take them up when we focus on app maintenance for a bit

Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: Norbert Schuler @.> Sent: Monday, September 16, 2024 7:22:55 PM To: Plant-for-the-Planet-org/planet-webapp @.> Cc: Mohit Bajaj @.>; Author @.> Subject: Re: [Plant-for-the-Planet-org/planet-webapp] Add missing translations (PR #2231)

@norbertschuler commented on this pull request.


In .vscode/tasks.jsonhttps://github.com/Plant-for-the-Planet-org/planet-webapp/pull/2231#discussion_r1761207757:

@@ -0,0 +1,17 @@ +{

  • // See https://go.microsoft.com/fwlink/?LinkId=733558
  • // for the documentation about the tasks.json format
  • "version": "2.0.0",
  • "tasks": [
  • {
  • "type": "shell",
  • "command": "npx tsc --noEmit --pretty | grep -A 1 \"is not assignable to parameter of type 'MessageKeys\"",

Running this task I get a lot of errors show like:

src/features/common/InputTypes/AutoCompleteCountry.tsx:69:23 - error TS2345: Argument of type 'string' is not assignable to parameter of type 'MessageKeys<{ auto: string; ac: string; af: string; ax: string; al: string; dz: string; as: string; ad: string; ao: string; ai: string; aq: string; ag: string; ar: string; am: string; aw: string; au: string; at: string; az: string; ... 241 more ...; zw: string; }, "de" | ... 258 more ... | "zw">'.

So is the plan to fix them after merging this or within this PR?

— Reply to this email directly, view it on GitHubhttps://github.com/Plant-for-the-Planet-org/planet-webapp/pull/2231#pullrequestreview-2306743707, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AKWWEYZPMHDSJWDWL4FBIBDZW3PDPAVCNFSM6AAAAABOI6LMJGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGMBWG42DGNZQG4. You are receiving this because you authored the thread.Message ID: @.***>