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

fix: some element-plus components doesn't has props 'options' #5082

Closed
wants to merge 5 commits into from

Conversation

ArthurDarkstone
Copy link
Contributor

@ArthurDarkstone ArthurDarkstone commented Dec 9, 2024

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

    • Introduced ElSelectV2 component, enhancing the selection functionality.
    • Redesigned CheckboxGroup and RadioGroup as functional components for improved flexibility and dynamic rendering.
  • Bug Fixes

    • Corrected the naming convention for the DefaultButton method.
  • Type Additions

    • Added new types CheckboxProps and RadioProps to define the structure of options for the checkbox and radio groups.

Sorry, something went wrong.

Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

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.

apps/web-ele/src/adapter/component/index.ts

Oops! Something went wrong! :(

ESLint: 9.15.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The changes in this pull request primarily involve updates to the index.ts file within the apps/web-ele/src/adapter/component directory. Key modifications include replacing the ElSelect component with ElSelectV2, redefining CheckboxGroup and RadioGroup as functional components for enhanced flexibility, and introducing new types CheckboxProps and RadioProps for option structure. Additionally, a naming correction was made from DefaulButton to DefaultButton. These updates aim to improve component rendering and registration within the Vue.js framework.

Changes

File Path Change Summary
apps/web-ele/src/adapter/component/index.ts - Replaced ElSelect with ElSelectV2.
- Redefined CheckboxGroup and RadioGroup as functional components.
- Introduced types CheckboxProps and RadioProps for options structure.
- Corrected method name from DefaulButton to DefaultButton.
- Adjusted component registration in initComponentAdapter.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

In the meadow where components play,
A new select has come to stay.
Checkboxes and radios, now so bright,
Rendered with options, a joyous sight!
With fixes and types, we hop along,
In the world of Vue, we all belong! 🐇✨


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 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

🧹 Outside diff range and nitpick comments (3)
apps/web-ele/src/adapter/component/index.ts (3)

42-46: Consider strengthening the TKV type definition

The current type allows any additional properties which could lead to type safety issues. Consider making it more strict by explicitly defining all allowed properties.

 type TKV = {
-  [key: string]: any;
   label: string;
   value: any;
+  disabled?: boolean;
 };

88-90: Add type safety to DefaultButton component

The implementation would benefit from proper type definitions for props and attrs.

-    DefaultButton: (props, { attrs, slots }) => {
+    DefaultButton: (props: Record<string, any>, { attrs, slots }: Omit<SetupContext, 'expose'>) => {
       return h(ElButton, { ...props, ...attrs, type: 'info' }, slots);
     },

Line range hint 1-7: Enhance documentation for component adaptations

While the existing comment explains the purpose, it would be helpful to add:

  1. Documentation for the new TKV type
  2. Examples of using options vs slots for CheckboxGroup and RadioGroup
  3. Notes about the ElSelectV2 migration
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 018ddc7 and 2d321bd.

📒 Files selected for processing (1)
  • apps/web-ele/src/adapter/component/index.ts (4 hunks)
🔇 Additional comments (1)
apps/web-ele/src/adapter/component/index.ts (1)

113-113: Verify ElSelectV2 compatibility with existing usage

The change from ElSelect to ElSelectV2 could be a breaking change. ElSelectV2 might have different props or behavior.

Consider:

  1. Adding a migration guide for users
  2. Documenting any behavioral differences
  3. Potentially making this a major version bump if there are breaking changes

apps/web-ele/src/adapter/component/index.ts Outdated Show resolved Hide resolved
apps/web-ele/src/adapter/component/index.ts Outdated Show resolved Hide resolved
@mynetfan
Copy link
Collaborator

mynetfan commented Dec 9, 2024

此PR有冲突,相关改动已在main分支中存在

…r better type safety
Copy link

changeset-bot bot commented Dec 9, 2024

⚠️ No Changeset found

Latest commit: afa0408

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 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

🧹 Outside diff range and nitpick comments (1)
apps/web-ele/src/adapter/component/index.ts (1)

81-83: Add type safety to button props

Consider adding proper typing for the button props to ensure type safety.

-    DefaultButton: (props, { attrs, slots }) => {
+    DefaultButton: (props: Partial<typeof ElButton.__defaults>, { attrs, slots }: Omit<SetupContext, 'expose'>) => {
       return h(ElButton, { ...props, attrs, type: 'info' }, slots);
     },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2d321bd and afa0408.

📒 Files selected for processing (1)
  • apps/web-ele/src/adapter/component/index.ts (3 hunks)
🔇 Additional comments (4)
apps/web-ele/src/adapter/component/index.ts (4)

68-79: Add type safety and fix attrs spreading

The CheckboxGroup implementation has several potential improvements needed:

  1. Props type safety is missing
  2. The attrs spreading syntax is incorrect
  3. No validation for option values

91-102: Refactor RadioGroup to reduce code duplication and add type safety

The RadioGroup implementation is nearly identical to CheckboxGroup, suggesting an opportunity for code reuse. It also needs the same type safety improvements.


15-15: Verify type definitions for CheckboxProps and RadioProps

The types are imported from element-plus but their structure should be documented for maintainability.

Also applies to: 31-31


103-103: Verify ElSelectV2 compatibility and performance

The switch from ElSelect to ElSelectV2 might introduce breaking changes. Please ensure:

  1. All existing select functionality works as expected
  2. Performance is not negatively impacted
  3. All existing props and events are compatible
✅ Verification successful

Let's analyze the Select component usage patterns and any potential breaking changes by searching with broader patterns and context.


Based on the search results, I can now generate a final response:

ElSelectV2 change appears safe with minimal usage impact

The codebase shows that:

  • The Select component is wrapped with withDefaultPlaceholder HOC, maintaining consistent placeholder behavior
  • Only one instance of Select usage found in login.vue using 'VbenSelect', which is an abstraction layer
  • The component is registered globally through globalShareState.setComponents

The change to ElSelectV2 appears safe because:

  1. The component is properly abstracted behind an adapter layer
  2. Usage is minimal and through higher-level components
  3. Basic props (v-model, options) remain compatible as per Element Plus documentation
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for existing Select component usage
rg -A 3 "Select.*options" 

# Search for any Select-specific props or events
ast-grep --pattern ':options="$_"'

Length of output: 64


Script:

#!/bin/bash
# Search for Select component usage patterns with broader context
rg -A 5 -B 5 "Select" apps/web-ele/src/

# Look for Select component props and usage
ast-grep --pattern 'Select $$$'

# Search for v-model usage with Select
rg -A 3 "v-model.*Select"

# Search for ElSelect usage patterns
rg -A 3 "ElSelect"

Length of output: 4800

@ArthurDarkstone
Copy link
Contributor Author

#5071 closed because of duplicate pr

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