fix(compiler-sfc): improved type resolution for function type aliases #13452

jh-leong · 2025-06-09T09:06:40Z

close #13444

refix Type inference failure in defineProps when using generic type aliases for function props #13240 by special-casing TSFunctionType in type aliases
prevents regression by skipping full resolution for other cases

Summary by CodeRabbit

New Features
- Improved type resolution for function type aliases, ensuring they are correctly recognized as functions at runtime.
Tests
- Added tests to verify correct handling of function type aliases and generic intersection type aliases in type resolution.
- Removed a test case related to TypeScript type aliases for function types in prop definitions.

coderabbitai · 2025-06-09T09:06:46Z

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

packages/compiler-sfc/__tests__/compileScript/__snapshots__/defineProps.spec.ts.snap is excluded by !**/*.snap

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update the type resolution logic for TypeScript type aliases in Vue's SFC compiler, specifically improving how function type aliases are inferred as runtime Function types. Tests are added to verify correct handling of function and branded type aliases, and one outdated test is removed.

Changes

File(s)	Change Summary
packages/compiler-sfc/src/script/resolveType.ts	Updated `inferRuntimeType` to directly return `['Function']` for type aliases of `TSFunctionType`.
packages/compiler-sfc/tests/compileScript/resolveType.spec.ts	Added tests for function type alias and branded (nominal) type alias handling in type resolution.
packages/compiler-sfc/tests/compileScript/defineProps.spec.ts	Removed the test case for function type alias with `withDefaults` in `defineProps`.

Sequence Diagram(s)

sequenceDiagram
    participant SFCCompiler
    participant TypeResolver

    SFCCompiler->>TypeResolver: inferRuntimeType(node: TSTypeReference)
    TypeResolver->>TypeResolver: resolve type alias (TSTypeAliasDeclaration)
    alt typeAnnotation is TSFunctionType
        TypeResolver-->>SFCCompiler: return ['Function']
    else other typeAnnotation
        TypeResolver->>TypeResolver: recursively infer runtime type
        TypeResolver-->>SFCCompiler: return inferred type
    end

Assessment against linked issues

Objective	Addressed	Explanation
Correctly infer runtime type for function type aliases in defineProps (e.g., generics, references) (#13240)	✅
Branded/nominal types in props fallback to UNKNOWN_TYPE when not resolvable (#13444)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Suggested labels

ready to merge, scope: sfc

Poem

In the warren where types abound,
Function aliases now are found!
Branded types, both new and old,
Are handled well—no bugs to scold.
With tests that hop and logic neat,
This patch is truly quite a treat!
🐇✨

🪧 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 · 2025-06-09T09:07:45Z

Size Report

Bundles

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

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.7 kB	18.2 kB	16.7 kB
createApp	54.6 kB	21.3 kB	19.4 kB
createSSRApp	58.9 kB	23 kB	21 kB
defineCustomElement	59.6 kB	22.9 kB	20.9 kB
overall	68.7 kB	26.4 kB	24.1 kB

pkg-pr-new · 2025-06-09T09:07:54Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: ad46d8d

jh-leong · 2025-06-09T09:12:31Z

/ecosystem-ci run

vue-bot · 2025-06-09T09:19:37Z

📝 Ran ecosystem CI: Open

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

fix(compiler-sfc): handle function type alias

5424818

edison1105 added ready to merge The PR is ready to be merged. scope: sfc 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels Jun 9, 2025

edison1105 approved these changes Jun 9, 2025

View reviewed changes

chore: update snap

ad46d8d

edison1105 changed the title ~~fix(compiler-sfc): handle function type alias~~ fix(compiler-sfc): improved type resolution for function type aliases Jun 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(compiler-sfc): improved type resolution for function type aliases #13452

fix(compiler-sfc): improved type resolution for function type aliases #13452

jh-leong commented Jun 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 9, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Jun 9, 2025

Uh oh!

pkg-pr-new bot commented Jun 9, 2025 •

edited

Loading

Uh oh!

jh-leong commented Jun 9, 2025

Uh oh!

vue-bot commented Jun 9, 2025

Uh oh!

Uh oh!

Uh oh!

fix(compiler-sfc): improved type resolution for function type aliases #13452

Are you sure you want to change the base?

fix(compiler-sfc): improved type resolution for function type aliases #13452

Conversation

jh-leong commented Jun 9, 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!

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

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Jun 9, 2025

Size Report

Bundles

Usages

Uh oh!

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

Uh oh!

Uh oh!

jh-leong commented Jun 9, 2025

Uh oh!

vue-bot commented Jun 9, 2025

Uh oh!

Uh oh!

jh-leong commented Jun 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jun 9, 2025 •

edited

Loading