Skip to content

feat(types): enhanced defineComponent inference #12935

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 130 commits into
base: minor
Choose a base branch
from
Open

feat(types): enhanced defineComponent inference #12935

wants to merge 130 commits into from

Conversation

johnsoncodehk
Copy link
Member

@johnsoncodehk johnsoncodehk commented Feb 24, 2025 •
edited
Loading

This PR is all about improving the implementations of defineComponent type inference. It's not a complete rewrite because we can't aggressively rewrite or remove existing types/interfaces to maintain backward compatibility (if we have plans for Vue 4 we can revisit that.)

Improvements / Changes

  • TS completion in component options is 40% faster
  • The "this" type in data and props options is more accurate
  • New DefineComponent2 type passes the structured component options type parameter as is, which streamlined .d.ts output on tsc emit: props types are now printed as is to .d.ts, same types are no longer serialized to multiple parameters in DefineComponent (reduce about 35% code in naive-ui .d.ts)
  • Tsc performance improved by about 8% in elk repo
  • Prop options (type, required, default, validator) can now navigate to TS definitions
  • emits: {} is now correctly handled as an empty event set
  • Simplified mixins, extends options inference (no longer using ComponentOptionsMixin intermediate type)
  • Simplify h function overloads (remove dependency on helper types such as DefineComponent, ConcreteComponent, etc.)

@johnsoncodehk
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented Mar 12, 2025

📝 Ran ecosystem CI: Open

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

@vue-bot
Copy link
Contributor

vue-bot commented Mar 12, 2025

📝 Ran ecosystem CI: Open

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

@johnsoncodehk
Copy link
Member Author

/ecosystem-ci run

@vue-bot
Copy link
Contributor

vue-bot commented Mar 12, 2025

📝 Ran ecosystem CI: Open

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

@johnsoncodehk johnsoncodehk mentioned this pull request Mar 13, 2025
Closed
@edison1105 edison1105 mentioned this pull request Mar 28, 2025
Merged
edison1105 added a commit to vuejs/ecosystem-ci that referenced this pull request Mar 28, 2025
@edison1105
chore: delete the previous ran results before create new comment (#23)
bdce46c 
avoid having too many run results in PR comments.
e.g. vuejs/core#12935
@johnsoncodehk
Copy link
Member Author

/ecosystem-ci run

@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vuejs vuejs deleted a comment from johnsoncodehk Mar 31, 2025
@vue-bot
Copy link
Contributor

vue-bot commented Mar 31, 2025

📝 Ran ecosystem CI: Open

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

@KazariEX KazariEX mentioned this pull request Jun 12, 2025
Open
@johnsoncodehk johnsoncodehk mentioned this pull request Jul 5, 2025
Closed
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 15, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacekkarczmarczyk jacekkarczmarczyk jacekkarczmarczyk left review comments

Assignees
No one assigned
Labels
version: minor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@johnsoncodehk @vue-bot @jacekkarczmarczyk @yyx990803 @KazariEX