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

Removing the use of HTMLNextUIProps create:cmp template #4790

Closed
wants to merge 1 commit into from

Conversation

macci001
Copy link
Contributor

@macci001 macci001 commented Feb 3, 2025

Closes #

📝 Description

The PR removes the use of HTMLNextUIProps.

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • Refactor
    • Updated the component’s property configuration to align with current UI design standards, ensuring improved consistency without changing its overall behavior.

@macci001 macci001 requested a review from jrgarciadev as a code owner February 3, 2025 18:34
Copy link

changeset-bot bot commented Feb 3, 2025

⚠️ No Changeset found

Latest commit: 77a3abb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Feb 3, 2025

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

Name Status Preview Comments Updated (UTC)
heroui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 3, 2025 6:37pm
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 3, 2025 6:37pm

Copy link
Contributor

coderabbitai bot commented Feb 3, 2025

Walkthrough

The change updates the file template for the component hook by modifying the import and interface definitions. The file now imports HTMLHeroUIProps instead of HTMLNextUIProps and adjusts the Props interface to extend HTMLHeroUIProps<"div"> accordingly. The change is focused on type definitions while maintaining the overall logic of the hook function.

Changes

File Change Summary
plop/.../use-{{componentName}}.ts.hbs Replaced the import of HTMLNextUIProps with HTMLHeroUIProps and updated the Props interface extension from HTMLNextUIProps<"div"> to HTMLHeroUIProps<"div">.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92281a6 and 77a3abb.

📒 Files selected for processing (1)
  • plop/component/src/use-{{componentName}}.ts.hbs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build
  • GitHub Check: TypeScript
🔇 Additional comments (2)
plop/component/src/use-{{componentName}}.ts.hbs (2)

3-3: LGTM! Import statement updated correctly.

The change from NextUI to HeroUI types aligns with the PR objectives.


9-9: Verify type compatibility between HTMLNextUIProps and HTMLHeroUIProps.

The interface update looks good, but let's verify that HTMLHeroUIProps provides equivalent type safety.

✅ Verification successful

Type compatibility appears consistent: The updated interface extending HTMLHeroUIProps with the "

" type parameter is in line with its widespread adoption across multiple components. The usage of HTMLHeroUIProps in numerous files indicates that it’s intended as a drop‐in replacement for HTMLNextUIProps, and no type conflicts or safety issues were detected.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check type definitions to ensure compatibility

# Search for HTMLHeroUIProps definition and usage
ast-grep --pattern 'export type HTMLHeroUIProps<$_> = $_'

# Search for any other components using HTMLHeroUIProps
rg -l "HTMLHeroUIProps" --type ts

Length of output: 5068


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.

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.

@wingkwong
Copy link
Member

handled in #4645 alraedy

@wingkwong wingkwong closed this Feb 4, 2025
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.

2 participants