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

type: narrow onChange argument to React.Key[] #352

Merged
merged 1 commit into from
Oct 28, 2024

Conversation

yuanliu147
Copy link
Contributor

@yuanliu147 yuanliu147 commented Sep 9, 2024

ant-design/ant-design#50754

Summary by CodeRabbit

  • 新功能
    • 改进了Collapse组件的onChange回调,增强了类型安全性,确保回调接收一个键数组。
  • 接口变更
    • 更新了CollapseProps接口中的onChange属性,使其仅接受键数组,确保一致性和清晰性。

Copy link

vercel bot commented Sep 9, 2024

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

Name Status Preview Comments Updated (UTC)
collapse ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 9, 2024 3:45am

Copy link

coderabbitai bot commented Sep 9, 2024

Walkthrough

此次更改涉及Collapse组件中的onChange回调和CollapseProps接口。onChange回调的参数类型由接受单个键或键数组的React.Key | React.Key[]更改为仅接受键数组React.Key[],从而提高了类型安全性。此更改确保了在处理活动键时,onChange函数始终接收一致的参数类型。

Changes

文件 更改摘要
src/Collapse.tsx, src/interface.ts 修改Collapse组件中的onChange回调,确保其仅接收React.Key[]类型的参数,增强类型安全性。

Poem

在兔子洞中轻轻跳,
键数组舞动真美妙。
类型安全如春风,
代码更清晰,心欢笑。
让我们一起欢庆这变化,
兔子们共舞,乐无穷! 🐇✨

Tip

New features:

  • Possibly related PRs: The walkthrough comment now includes a list of potentially related PRs to help you recall past context.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

  • Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

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.
    • @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

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

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 44a5d48 and 90933b4.

Files selected for processing (2)
  • src/Collapse.tsx (1 hunks)
  • src/interface.ts (1 hunks)
Additional comments not posted (2)
src/interface.ts (1)

27-27: 类型定义已正确更新。

onChange 属性的类型已从 React.Key | React.Key[] 更改为 React.Key[],这有助于提高类型安全性。请确保所有使用此接口的组件都已更新,以传递键数组。

运行以下脚本以验证整个代码库中 onChange 的使用情况:

Verification successful

类型定义更新已在代码库中正确实施。

onChange 属性的类型更新为 React.Key[] 已在主要实现和测试文件中得到正确应用。请确保文档示例也反映了此更新。

  • src/Collapse.tsx 中的 onChange 使用符合新签名。
  • tests/index.spec.tsx 中的测试用例验证了新签名的正确性。
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述:验证所有 `onChange` 函数调用都匹配新的签名。

# 测试:搜索函数使用情况。预期:只有新签名的出现。
rg --type typescript -A 5 $'onChange'

Length of output: 71


Script:

#!/bin/bash
# 描述:验证所有 `onChange` 函数调用都匹配新的签名。

# 测试:搜索函数使用情况。预期:只有新签名的出现。
rg --glob '*.ts' --glob '*.tsx' -A 5 $'onChange'

Length of output: 7771

src/Collapse.tsx (1)

41-41: 类型断言已正确添加。

useMergedState 钩子中,onChange 回调现在显式地将值转换为 React.Key[],这与接口的更改保持一致,确保类型安全性。请通过单元测试验证此更改不会引入任何意外的副作用。

运行以下脚本以验证 onChange 回调的功能:

Verification successful

类型断言已正确添加且通过测试验证。

src/Collapse.tsx 中对 onChange 回调的更改已通过现有的单元测试验证。这些测试确保 onChange 回调按预期工作,并且类型断言不会引入任何意外的副作用。

  • 相关测试文件:tests/index.spec.tsx
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述:验证 `onChange` 回调的功能是否按预期工作。

# 测试:搜索相关的单元测试。预期:找到并运行测试以确认功能。
rg --type typescript -A 5 $'onChange'

Length of output: 71


Script:

#!/bin/bash
# 描述:验证 `onChange` 回调的功能是否按预期工作。

# 测试:搜索相关的单元测试。预期:找到并运行测试以确认功能。
rg --type ts -A 5 $'onChange'

Length of output: 7752

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.13%. Comparing base (44a5d48) to head (90933b4).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #352   +/-   ##
=======================================
  Coverage   99.13%   99.13%           
=======================================
  Files           5        5           
  Lines         116      116           
  Branches       42       42           
=======================================
  Hits          115      115           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@afc163 afc163 merged commit 5b50798 into react-component:master Oct 28, 2024
7 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.

2 participants