Skip to content

fix(runtime-core): add undefined to NativeType type (fix #13593) #13594

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 2 commits into
base: main
Choose a base branch
from

Conversation

Dylancyclone
Copy link

@Dylancyclone Dylancyclone commented Jul 8, 2025

Fixes: #13593

See that issue for more information

The InferDefault type filters out any type that isn't listed in NativeType, and instead requests a function that returns the type intersected with an empty object ({}). However, the intersection with an empty object discards null and undefined (According to the docs). This isn't an issue for null, because it is explicitly listed as a NativeType, however this causes an issue for undefined.

Currently, when exactOptionalPropertyTypes and strictNullChecks are true, you cannot set a prop's default value to undefined even if it's listed as a possible type. This fixes the issue by explicitly letting it be a default value

Summary by CodeRabbit

  • Refactor
    • Improved type handling to better support cases where values may be undefined.

Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

The type alias NativeType in apiSetupHelpers.ts was updated to include undefined as a possible value. This change ensures that type inference logic using NativeType—notably in InferDefault—now correctly recognizes undefined as a valid default value. No other logic or functionality was modified.

Changes

File(s) Change Summary
packages/runtime-core/src/apiSetupHelpers.ts Added undefined to NativeType type alias definition

Assessment against linked issues

Objective Addressed Explanation
Allow props of type possibly undefined to have a default value of undefined with exactOptionalPropertyTypes and strictNullChecks enabled (#13593)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Suggested labels

scope: types

Suggested reviewers

  • johnsoncodehk
  • edison1105

Poem

A rabbit hopped through types so neat,
And found undefined had no seat.
With a flick of its paw,
It fixed the type law—
Now props and their defaults can meet!
🐇✨


📜 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 02984a4 and 1b1e93f.

📒 Files selected for processing (1)
  • packages/runtime-core/src/apiSetupHelpers.ts (1 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/runtime-core/src/apiSetupHelpers.ts

[error] 329-329: Don't use 'Function' as a type.

Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs.

(lint/complexity/noBannedTypes)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
🔇 Additional comments (1)
packages/runtime-core/src/apiSetupHelpers.ts (1)

322-329: LGTM! The addition of undefined to NativeType correctly addresses the TypeScript strict mode issue.

This change allows undefined to be used as a direct default value for props when exactOptionalPropertyTypes and strictNullChecks are enabled, which is consistent with how null is already handled in the type system.

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

@Dylancyclone Dylancyclone changed the title Add undefined to NativeType type fix(runtime-core): Add undefined to NativeType type (fix #13593) Jul 8, 2025
@Dylancyclone Dylancyclone changed the title fix(runtime-core): Add undefined to NativeType type (fix #13593) fix(runtime-core): add undefined to NativeType type (fix #13593) Jul 8, 2025
Copy link

github-actions bot commented Jul 9, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.4 kB 34.5 kB
vue.global.prod.js 159 kB 58.5 kB 52.1 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.5 kB 18.2 kB 16.7 kB
createApp 54.5 kB 21.2 kB 19.4 kB
createSSRApp 58.7 kB 22.9 kB 20.9 kB
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.5 kB 26.4 kB 24 kB

Copy link

pkg-pr-new bot commented Jul 9, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 1b1e93f

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: types labels Jul 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready to merge The PR is ready to be merged. scope: types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prop that is possibly undefined cannot be defaulted to undefined when exactOptionalPropertyTypes and strictNullChecks are true
2 participants