Skip to content

fix(vue-common): compatible with camel case format and mutton string format of transferred attributes, optimized attribute overwriting logic #3427

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

Merged
merged 1 commit into from
May 15, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented May 14, 2025

fix(vue-common): 兼容处理传递属性的驼峰格式和羊肉串格式,优化属性覆盖逻辑

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes
    • Improved recognition of user-defined design properties, ensuring compatibility with both camelCase and kebab-case formats. This prevents user settings from being unintentionally overwritten.

Copy link

coderabbitai bot commented May 14, 2025

Walkthrough

The update modifies the internal logic of the $setup function to recognize both camelCase and kebab-case property keys when handling design configuration properties. This ensures that user-provided properties are respected regardless of their naming convention, preventing default values from overwriting them unintentionally.

Changes

File(s) Change Summary
packages/vue-common/src/index.ts Enhanced $setup to check for both camelCase and kebab-case keys in customProps before assigning default design property values.

Poem

A hop and a skip, through code we leap,
Now camel and kebab, in harmony keep.
No more confusion, no props left behind,
Both cases are handled, with logic refined.
The bunny approves—our setup’s now neat! 🐇✨

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

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.

packages/vue-common/src/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Tip

⚡️ 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.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4397f2f and 6eaddd8.

📒 Files selected for processing (1)
  • packages/vue-common/src/index.ts (1 hunks)
🔇 Additional comments (1)
packages/vue-common/src/index.ts (1)

192-199: Excellent improvement for attribute format compatibility!

This enhancement properly handles both camelCase and kebab-case formats for component attributes, which prevents unintended overwriting of user-defined properties. Now the component will recognize user props regardless of naming convention, making the API more flexible and intuitive.

The implementation correctly:

  1. Converts between formats using appropriate regex patterns
  2. Checks for property existence in both formats before applying defaults
  3. Uses Object.prototype.hasOwnProperty.call() for safer property checking
✨ 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.

@github-actions github-actions bot added the bug Something isn't working label May 14, 2025
Copy link

Walkthrough

This PR enhances the compatibility of attribute handling by supporting both camel case and kebab case formats. It also optimizes the logic for attribute overwriting, ensuring that only attributes not configured by the user are overwritten.

Changes

File Summary
packages/vue-common/src/index.ts Added logic to handle both camel case and kebab case formats for attributes, and improved the condition for overwriting attributes.

// 用户没有配置的属性才进行覆盖
if (!Object.prototype.hasOwnProperty.call(customProps, key)) {
if (
!Object.prototype.hasOwnProperty.call(customProps, camelKey) &&

Choose a reason for hiding this comment

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

The new logic ensures compatibility with both camel case and kebab case formats for attributes. This change prevents overwriting user-configured attributes by checking both formats before proceeding.

@kagol kagol merged commit f9d88bc into dev May 15, 2025
11 checks passed
@kagol kagol deleted the fix-config-camel-0514 branch May 15, 2025 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants