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

refactor: fix type error in image-crop.tsx #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

javier-godoy
Copy link
Member

@javier-godoy javier-godoy commented Feb 13, 2025

Close #15

Summary by CodeRabbit

  • New Features
    • Enhanced image cropping functionality to now support percentage-based cropping alongside pixel-based adjustments, offering more flexibility when adjusting and previewing crop areas.

Copy link

coderabbitai bot commented Feb 13, 2025

Walkthrough

This change introduces support for percentage-based cropping in the image crop component. The update extends the import statement to include the PercentCrop type and modifies the onImageLoad function. The function now conditionally handles cropping based on whether the unit is pixels or percentages, casting the crop value accordingly before using the makeAspectCrop function.

Changes

File Change Summary
src/.../image-crop.tsx - Updated import to include PercentCrop from react-image-crop
- Modified onImageLoad to check for crop unit and cast as PixelCrop or PercentCrop

Suggested reviewers

  • mlopezFC

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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

🧹 Nitpick comments (1)
src/main/resources/META-INF/resources/frontend/src/image-crop.tsx (1)

48-60: Consider improving type safety and reducing code duplication.

While the implementation correctly handles both pixel and percentage-based crops, there are opportunities for improvement:

  1. The type casting with as could be unsafe if crop.unit doesn't match the cast type
  2. There's code duplication in the centerCrop calls
  3. No handling for invalid unit types

Consider this refactored version:

-				if (crop.unit==='px') {
-					setCrop(centerCrop(
-						makeAspectCrop(crop as PixelCrop, aspect, width, height),
-						width,
-						height
-					));
-				} else if (crop.unit==='%') {
-					setCrop(centerCrop(
-						makeAspectCrop(crop as PercentCrop, aspect, width, height),
-						width,
-						height
-					));
-				}
+				const validUnits = ['px', '%'] as const;
+				if (!validUnits.includes(crop.unit)) {
+					console.warn(`Invalid crop unit: ${crop.unit}`);
+					return;
+				}
+				
+				const typedCrop = crop.unit === 'px' 
+					? (crop as PixelCrop) 
+					: (crop as PercentCrop);
+				
+				setCrop(centerCrop(
+					makeAspectCrop(typedCrop, aspect, width, height),
+					width,
+					height
+				));

This refactored version:

  • Validates crop units before processing
  • Reduces code duplication
  • Maintains type safety with a single type cast
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79a334c and 3b4b66f.

📒 Files selected for processing (1)
  • src/main/resources/META-INF/resources/frontend/src/image-crop.tsx (2 hunks)
🔇 Additional comments (1)
src/main/resources/META-INF/resources/frontend/src/image-crop.tsx (1)

24-24: LGTM! Import statement updated correctly.

The addition of PercentCrop type is consistent with the PR objective and enables proper type checking for percentage-based crops.

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.

Type error in image-crop.tsx
1 participant