Skip to content

chore: export framework components for use in independent pages #6245

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

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

Conversation

zwtvip
Copy link
Contributor

@zwtvip zwtvip commented May 20, 2025

Description

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features
    • Added new checkbox and select components for use in the user interface.

Copy link

changeset-bot bot commented May 20, 2025

⚠️ No Changeset found

Latest commit: f7bae8a

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
Contributor

coderabbitai bot commented May 20, 2025

Walkthrough

Two new components, VbenCheckbox and VbenSelect, were added to the export list in the packages/effects/common-ui/src/components/index.ts file, making them available for use throughout the codebase. No other changes were made.

Changes

File(s) Change Summary
packages/effects/common-ui/src/components/index.ts Added VbenCheckbox and VbenSelect to the named exports.

Poem

Two new friends join the UI crew,
Checkbox and Select, fresh as dew.
Now hopping along in the export line,
Ready to help your forms look fine.
With every click and every check,
The codebase grows—what the heck!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 8ac9768 and f7bae8a.

📒 Files selected for processing (1)
  • packages/effects/common-ui/src/components/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Check (ubuntu-latest)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)

@@ -17,13 +17,15 @@ export {
VbenAvatar,
VbenButton,
VbenButtonGroup,
VbenCheckbox,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify the existence of VbenCheckbox in the source package
Ensure that VbenCheckbox is actually exported by @vben-core/shadcn-ui and, if so, update any relevant documentation or storybook entries to reflect this new export.

Please run the following script to confirm the export:


🏁 Script executed:

#!/bin/bash
# Verify that VbenCheckbox is exported from @vben-core/shadcn-ui
grep -R "export.*VbenCheckbox" node_modules/@vben-core/shadcn-ui || echo "VbenCheckbox not found in @vben-core/shadcn-ui"

Length of output: 236


Missing export for VbenCheckbox – please correct the source or remove it

The grep check failed because node_modules/@vben-core/shadcn-ui doesn’t exist, so we can’t confirm that VbenCheckbox is exported. Please:

  • Verify that the package name and version in packages/effects/common-ui/package.json match the one that should provide VbenCheckbox.
  • If the correct package is something else (e.g. @vben/shadcn-ui), update the import/export path accordingly.
  • If no package actually exports VbenCheckbox, remove it from packages/effects/common-ui/src/components/index.ts (line 20) or replace it with the proper component.
🤖 Prompt for AI Agents
In packages/effects/common-ui/src/components/index.ts at line 20, the component
VbenCheckbox is exported but the source package @vben-core/shadcn-ui does not
exist or does not export it. Verify the correct package name and version in
packages/effects/common-ui/package.json to ensure it matches the intended
source. If the correct package is different, update the import/export path
accordingly. If no package exports VbenCheckbox, remove it from the export list
or replace it with the correct component.

VbenCheckButtonGroup,
VbenCountToAnimator,
VbenFullScreen,
VbenInputPassword,
VbenLoading,
VbenLogo,
VbenPinInput,
VbenSelect,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify the existence of VbenSelect in the source package
Ensure that VbenSelect is actually exported by @vben-core/shadcn-ui and, if so, update any relevant documentation or storybook entries to reflect this new export.

Please run the following script to confirm the export:


🏁 Script executed:

#!/bin/bash
# Verify that VbenSelect is exported from @vben-core/shadcn-ui
grep -R "export.*VbenSelect" node_modules/@vben-core/shadcn-ui || echo "VbenSelect not found in @vben-core/shadcn-ui"

Length of output: 230


🏁 Script executed:

#!/bin/bash
set -e

echo "Modules in node_modules matching 'vben':"
ls node_modules | grep vben || echo "No modules prefixed with 'vben' found"

echo
echo "Contents of node_modules/@vben-core (if exists):"
ls node_modules/@vben-core || echo "Directory node_modules/@vben-core not found"

echo
echo "Looking for '@vben-core/shadcn-ui' in package manifests:"
grep -R "\"@vben-core/shadcn-ui\"" -n package.json package-lock.json yarn.lock || echo "No reference to '@vben-core/shadcn-ui' in lock files"

echo
echo "Searching the codebase for any usage of 'VbenSelect':"
rg "VbenSelect" -n . || echo "No occurrences of 'VbenSelect' found in the codebase"

Length of output: 1779


🏁 Script executed:

#!/bin/bash
# Determine the package name in shadcn-ui package.json
grep -R "\"name\"" -n packages/@core/ui-kit/shadcn-ui/package.json || echo "package.json not found"

# Inspect exports field and main/module entries
grep -R "\"exports\"" -n packages/@core/ui-kit/shadcn-ui/package.json || echo "No exports field"
grep -R "\"main\"" -n packages/@core/ui-kit/shadcn-ui/package.json
grep -R "\"module\"" -n packages/@core/ui-kit/shadcn-ui/package.json

Length of output: 433


🏁 Script executed:

#!/bin/bash

echo "===== package.json (lines 1-80) ====="
sed -n '1,80p' packages/@core/ui-kit/shadcn-ui/package.json || echo "Cannot read package.json"

echo
echo "===== src/index.ts (entire file) ====="
sed -n '1,200p' packages/@core/ui-kit/shadcn-ui/src/index.ts || echo "Cannot read src/index.ts"

echo
echo "===== Components directory structure ====="
find packages/@core/ui-kit/shadcn-ui/src/components -maxdepth 2 -type f -print || echo "Cannot read components directory"

Length of output: 6475


✅ VbenSelect export confirmed
VbenSelect is indeed exported from @vben-core/shadcn-ui (see src/components/select/index.ts). No code changes are required—please update any downstream documentation or Storybook stories to include usage examples for this component.

Areas to update (examples):

  • Component reference in your docs folder
  • Storybook entry for “Select” under your UI kit stories
🤖 Prompt for AI Agents
In packages/effects/common-ui/src/components/index.ts at line 28, the export of
VbenSelect from @vben-core/shadcn-ui is confirmed to be valid. No code changes
are needed here. Instead, update any relevant documentation and Storybook
stories to include VbenSelect usage examples, ensuring downstream references
reflect this new export.

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