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: hardcode delete confirmation text to avoid translation mismatch #1487

Merged
merged 6 commits into from
Nov 22, 2024

Conversation

ephraimduncan
Copy link
Contributor

@ephraimduncan ephraimduncan commented Nov 20, 2024

Summary by CodeRabbit

  • New Features

    • Updated placeholder text in the Delete Document dialog to provide clearer instructions: "To confirm delete, type: delete".
  • Bug Fixes

    • Enhanced input validation for the delete action in the Delete Document dialog, ensuring a smoother user experience.

Copy link

vercel bot commented Nov 20, 2024

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

Name Status Preview Comments Updated (UTC)
prd-app 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 22, 2024 7:08am
prd-marketing 🔄 Building (Inspect) Visit Preview 💬 Add feedback Nov 22, 2024 7:08am
prd-openpage-api ❌ Failed (Inspect) Nov 22, 2024 7:08am
stg-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 22, 2024 7:08am
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
prd-docs ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 7:08am
stg-docs ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 7:08am
stg-marketing ⬜️ Ignored (Inspect) Visit Preview Nov 22, 2024 7:08am

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The changes involve a modification to the DeleteDocumentDialog component, specifically enhancing the user interface by updating the placeholder text in the Input component. A new constant deleteMessage has been introduced to hold the localized string for 'delete', which is used in the input validation logic. The condition for enabling the delete button now references this constant instead of a hardcoded string. The overall structure and functionality of the component, including state management and document deletion handling, remain unchanged.

Changes

File Path Change Summary
apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx Updated placeholder text in the Input component and modified delete button logic to use a new constant for validation.

Poem

In the dialog where documents lay,
A clearer prompt now lights the way.
"Type 'delete'" it gently sings,
To confirm the end of all those things!
A hop of joy for changes bright,
A better guide in day and night! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint (1.23.1)

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the config "@documenso/eslint-config" to extend from. Please check that the name of the config is correct.

The config "@documenso/eslint-config" was referenced from the config file in "/.eslintrc.cjs".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 051c7a7 and 9948500.

📒 Files selected for processing (1)
  • apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx

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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 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

🚨 @ephraimduncan has 11 pull requests awaiting review. Please consider reviewing them when possible. 🚨

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 (1)
apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx (1)

90-90: Consider UX impact of hardcoded English text

While hardcoding 'delete' prevents translation mismatches, it forces non-English speakers to type an English word. Consider these alternatives:

  1. Use a case-insensitive comparison to be more forgiving:
-    setIsDeleteEnabled(event.target.value === 'delete');
+    setIsDeleteEnabled(event.target.value.toLowerCase() === 'delete');
  1. Or use a numeric confirmation code instead:
-    setIsDeleteEnabled(event.target.value === 'delete');
+    setIsDeleteEnabled(event.target.value === '123456');
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 83e7a3c and 1575a03.

📒 Files selected for processing (1)
  • apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx (1 hunks)
🔇 Additional comments (1)
apps/web/src/app/(dashboard)/documents/delete-document-dialog.tsx (1)

90-90: Update placeholder text to match hardcoded value

Since we're now requiring the English word 'delete', ensure the placeholder text (line 165) is consistent with this requirement and doesn't get translated:

-            placeholder={_(msg`Type 'delete' to confirm`)}
+            placeholder="Type 'delete' to confirm"

@dguyen
Copy link
Collaborator

dguyen commented Nov 20, 2024

They should be typing in the translation version, not delete

@dguyen dguyen merged commit cd5adce into main Nov 22, 2024
17 of 18 checks passed
@dguyen dguyen deleted the fix/delete-document-input branch November 22, 2024 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apps: web Issues related to the webapp
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants