fix(types): exclude `undefined` from inferred prop types with default values #13007

jh-leong · 2025-03-08T10:35:54Z

Summary by CodeRabbit

Tests
- Expanded test coverage for component props with new required and optional prop types, including default values and explicit type annotations.
Bug Fixes
- Enhanced type inference for required props to exclude undefined only when a default value is present, ensuring more accurate prop type definitions.

… values

pkg-pr-new · 2025-03-08T10:37:59Z

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13007

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13007

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13007

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13007

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13007

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13007

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13007

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13007

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13007

vue

npm i https://pkg.pr.new/vue@13007

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13007

commit: 622e07d

github-actions · 2025-03-08T10:46:31Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB	38.3 kB	34.6 kB
vue.global.prod.js	159 kB	58.5 kB	52 kB

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.2 kB	19.4 kB
createSSRApp	58.8 kB	23 kB	20.9 kB
defineCustomElement	59.5 kB	22.8 kB	20.8 kB
overall	68.6 kB	26.4 kB	24.1 kB

coderabbitai · 2025-05-19T00:43:42Z

"""

Walkthrough

The changes update type inference for required props in the ExtractPropTypes utility, ensuring that required props with default values no longer include undefined in their inferred types. The test suite for defineComponent was extended to verify this behavior by adding new props and updating type assertions accordingly.

Changes

File(s)	Change Summary
`packages/runtime-core/src/componentProps.ts`	Updated `ExtractPropTypes` so required props exclude `undefined` from their inferred types when a default exists.
`packages-private/dts-test/defineComponent.test-d.tsx`	Added `aa`, `aaa`, and `aaaa` props to test suite; updated `ExpectedProps` interface; extended type assertions and JSX usage accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant defineComponent
    participant ExtractPropTypes

    Developer->>defineComponent: Define component with props (some with default values)
    defineComponent->>ExtractPropTypes: Infer prop types
    ExtractPropTypes-->>defineComponent: Return types (required props exclude undefined)
    defineComponent-->>Developer: Component instance with correct prop types

Assessment against linked issues

Objective	Addressed	Explanation
Ensure required props with default values do not include `undefined` in their inferred types (#13006)	✅

Poem

Oh, what a joy, a type rabbit’s delight,
Required props are now inferred right!
No more undefined sneaking in unseen,
With tests and types, our code is clean.
We hop with glee, our mission clear—
Typed props bring us much cheer! 🐇✨
"""

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 30th. 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
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 650ea4f and 622e07d.

📒 Files selected for processing (2)

packages-private/dts-test/defineComponent.test-d.tsx (7 hunks)
packages/runtime-core/src/componentProps.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

packages/runtime-core/src/componentProps.ts
packages-private/dts-test/defineComponent.test-d.tsx

✨ Finishing Touches

📝 Generate Docstrings

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

jh-leong · 2025-05-21T13:27:53Z

/ecosystem-ci run

vue-bot · 2025-05-21T13:34:46Z

📝 Ran ecosystem CI: Open

suite	result	latest scheduled
language-tools	✅ success	✅ success
radix-vue	✅ success	✅ success
nuxt	✅ success	✅ success
primevue	✅ success	✅ success
quasar	✅ success	✅ success
pinia	✅ success	✅ success
test-utils	✅ success	✅ success
vitepress	✅ success	✅ success
vueuse	✅ success	✅ success
vant	✅ success	✅ success
vue-i18n	✅ success	✅ success
router	✅ success	✅ success
vue-simple-compiler	✅ success	✅ success
vue-macros	✅ success	✅ success
vuetify	✅ success	✅ success
vite-plugin-vue	✅ success	✅ success

fix(types): exclude undefined from inferred prop types with default…

fed42b8

… values

jh-leong added the scope: types label Mar 8, 2025

edison1105 added the ready to merge The PR is ready to be merged. label Mar 8, 2025

KazariEX approved these changes May 18, 2025

View reviewed changes

edison1105 approved these changes May 19, 2025

View reviewed changes

Merge branch 'main' into fix/13006

650ea4f

jh-leong marked this pull request as draft May 19, 2025 14:27

jh-leong removed the ready to merge The PR is ready to be merged. label May 19, 2025

fix(types): correct handling of required props with undefined type

622e07d

vuejs deleted a comment from jh-leong May 21, 2025

jh-leong marked this pull request as ready for review May 21, 2025 13:34

jh-leong requested a review from edison1105 May 21, 2025 13:35

edison1105 requested review from KazariEX and johnsoncodehk May 21, 2025 14:12

johnsoncodehk approved these changes May 21, 2025

View reviewed changes

KazariEX approved these changes May 21, 2025

View reviewed changes

edison1105 merged commit 5179d32 into vuejs:main May 22, 2025
14 checks passed

jh-leong deleted the fix/13006 branch May 23, 2025 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(types): exclude `undefined` from inferred prop types with default values #13007

fix(types): exclude `undefined` from inferred prop types with default values #13007

Uh oh!

jh-leong commented Mar 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

pkg-pr-new bot commented Mar 8, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Mar 8, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 19, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

jh-leong commented May 21, 2025

Uh oh!

vue-bot commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(types): exclude undefined from inferred prop types with default values #13007

fix(types): exclude undefined from inferred prop types with default values #13007

Uh oh!

Conversation

jh-leong commented Mar 8, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

pkg-pr-new bot commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

coderabbitai bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

jh-leong commented May 21, 2025

Uh oh!

vue-bot commented May 21, 2025

Uh oh!

Uh oh!

Uh oh!

fix(types): exclude `undefined` from inferred prop types with default values #13007

fix(types): exclude `undefined` from inferred prop types with default values #13007

jh-leong commented Mar 8, 2025 •

edited by coderabbitai bot

Loading

pkg-pr-new bot commented Mar 8, 2025 •

edited

Loading

github-actions bot commented Mar 8, 2025 •

edited

Loading

coderabbitai bot commented May 19, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)