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

feat: add style attribute in components.json #2632

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

winchesHe
Copy link
Member

@winchesHe winchesHe commented Apr 2, 2024

Closes #

📝 Description

New components.json data like following

image

Add a brief description

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Enhanced documentation by automatically extracting and including style information from MDX component files.

Copy link

changeset-bot bot commented Apr 2, 2024

⚠️ No Changeset found

Latest commit: 2cd005a

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 Apr 2, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 2, 2024 3:31pm

Copy link
Contributor

coderabbitai bot commented Apr 2, 2024

Walkthrough

The recent update introduces enhancements to the post-build process for a React project. Specifically, it involves the addition of a new declaration for the Docs components directory path and an update to the logic for extracting style information. This extraction targets MDX component files, aiming to enrich the componentInfo object with detailed style data, thereby improving documentation and developer experience.

Changes

File Path Change Summary
.../react/src/scripts/postbuild.js Added docsComponentsDir declaration and updated logic to extract style info from MDX files.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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/coderabbit-overrides.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

vercel bot commented Apr 2, 2024

@winchesHe is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

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 Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 2e49e08 and 2cd005a.
Files selected for processing (1)
  • packages/core/react/src/scripts/postbuild.js (2 hunks)
Additional comments not posted (3)
packages/core/react/src/scripts/postbuild.js (3)

16-16: The declaration of docsComponentsDir correctly specifies the path to the Docs components directory. This is a straightforward addition and seems correctly implemented.


43-48: The logic to extract style information from MDX component files uses a regex to find a specific pattern. While the regex seems to be correctly targeting the intended pattern, consider the following points:

  • Ensure the regex pattern covers all possible variations of the ComponentLinks tag that might contain style information.
  • The use of optional chaining (?.[1]) and the fallback to an empty string ('') for missing style information is a good practice. However, it's important to ensure that this aligns with the expectations for components without explicitly defined styles.

45-45: The current implementation checks for the existence of the MDX file before attempting to read it, which is a good practice. However, consider adding a try-catch block around the fs.readFileSync call to handle any unexpected errors during the file reading process. This would ensure robustness and prevent the script from failing due to unhandled exceptions.

@jrgarciadev jrgarciadev merged commit 6811ce5 into nextui-org:main Apr 2, 2024
7 of 8 checks passed
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.

None yet

2 participants