Skip to content

feat(compiler): compiler supports search tag #9249

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

Conversation

baiwusanyu-c
Copy link
Member

close: #9247

@github-actions
Copy link

github-actions bot commented Sep 19, 2023

Size Report

Bundles

File Size Gzip Brotli
compiler-dom.global.prod.js 84.2 kB (+125 B) 29.8 kB (+45 B) 26.3 kB (+23 B)
runtime-dom.global.prod.js 103 kB (+65 B) 39.1 kB (+26 B) 35.2 kB (-22 B)
vue.global.prod.js 161 kB (+106 B) 59.3 kB (+33 B) 52.9 kB (+105 B)

Usages

Name Size Gzip Brotli
createApp (CAPI only) 47.5 kB 18.6 kB 17 kB
createApp 55.9 kB 21.7 kB 19.8 kB
createApp + vaporInteropPlugin 67.9 kB 25.9 kB 23.6 kB
createVaporApp 20.8 kB 8.28 kB 7.57 kB
createSSRApp 60.2 kB 23.5 kB 21.4 kB
defineCustomElement 60.9 kB 23.2 kB 21.2 kB
overall 70.2 kB 26.9 kB 24.5 kB
sxzz
sxzz previously approved these changes Sep 19, 2023
@sxzz sxzz added ready to merge The PR is ready to be merged. 🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. labels Sep 19, 2023
@haoqunjiang haoqunjiang changed the base branch from main to minor October 19, 2023 11:05
@yyx990803
Copy link
Member

The way we handle built-in HTML tags makes this technically a breaking change if someone was previously having a component named search.

Right now:

  • If a tag is listed as built-in, it can't be registered as a component because the parser directly parses the tag as native.
  • If a tag is not listed as built-in but used in template, there will be a "failed to resolve component" warning.

Considering there might be more tags being added in the future, we might need to have a separate list of "late added tags". For these tags:

  • The parser will still parse them as potential components
  • At runtime, it will use a component with matching name if it is registered (but a "Do not use built-in tag..." warning is still thrown)
  • If no matching component is found, it falls back to render as native element, without the "failed to resolve component" warning.
@lukewarlow
Copy link

To provide a concrete example of more new tag names that might get added. https://open-ui.org/components/selectlist/ OpenUI is currently working on a new stylable select element, as part of that proposal at least 3 new Html elements are currently proposed to be added. And it's likely that more such elements will be added as time goes on. So search is definitely not going to be a one of or even necessarily a rarity.

@baiwusanyu-c baiwusanyu-c force-pushed the bwsy/feat/compilerSearchElm branch from e69964d to be735d7 Compare October 23, 2023 13:44
@sxzz sxzz force-pushed the bwsy/feat/compilerSearchElm branch 2 times, most recently from 13329f8 to 3b41769 Compare October 28, 2023 07:02
@sxzz
Copy link
Member

sxzz commented Oct 10, 2024

Because the minor branch is 2 commits ahead of main. We should update the minor branch first.

@edison1105 edison1105 deleted the branch vuejs:minor October 21, 2024 07:37
@edison1105 edison1105 closed this Oct 21, 2024
@edison1105 edison1105 reopened this Oct 21, 2024
@edison1105 edison1105 moved this to Todo in Next Minor Jul 6, 2025
@edison1105 edison1105 moved this from Todo to In Progress in Next Minor Jul 6, 2025
@edison1105 edison1105 removed the status in Next Minor Jul 6, 2025
Copy link

coderabbitai bot commented Jul 7, 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.


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.
@baiwusanyu-c baiwusanyu-c force-pushed the bwsy/feat/compilerSearchElm branch from 749266e to 6d1f90e Compare July 7, 2025 03:02
@baiwusanyu-c baiwusanyu-c force-pushed the bwsy/feat/compilerSearchElm branch from 6d1f90e to 835fc82 Compare July 7, 2025 03:06
Copy link

pkg-pr-new bot commented Jul 7, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/compiler-vapor

npm i https://pkg.pr.new/@vue/compiler-vapor@9249 

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/runtime-vapor

npm i https://pkg.pr.new/@vue/runtime-vapor@9249 

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 52369c2

@baiwusanyu-c
Copy link
Member Author

This pr adds a getSetupReturnedHelper function to the SFC compilation result to implement runtime component name judgment when using option api or setup script. When the component tag name belongs to 'lateTag', it will throw a warning, but still render the component.

preview

setup script
option api
As a dom tag

@baiwusanyu-c baiwusanyu-c requested a review from edison1105 July 7, 2025 13:27
@edison1105
Copy link
Member

We should also consider the following cases:
Playground with this PR

@@ -98,6 +101,7 @@ export const helperNameMap: Record<symbol, string> = {
[CREATE_TEXT]: `createTextVNode`,
[CREATE_STATIC]: `createStaticVNode`,
[RESOLVE_COMPONENT]: `resolveComponent`,
[RESOLVE_SETUP_RETURNED]: `resolveSetupReturned`,
Copy link
Member

@edison1105 edison1105 Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think resolveLateAddedTag would be a more appropriate name. Perhaps this runtimehelper isn't necessary, for late add tag we can directly use resolveComponent

: `$setup[${JSON.stringify(fromConst)}]`
: `${helper(getSetupReturnedHelper())}(${JSON.stringify(
fromConst,
)}, $setup)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The $setup parameter is unnecessary to pass, as it can be obtained during runtime via currentRenderingInstance.setupState, which also helps reduce bundle size.

Copy link
Member

@edison1105 edison1105 Jul 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we should use isLateTag to check fromConst, and only use setupReturnedHelper or just use resolveComponent when it's a late added tag. Otherwise, it should remain unchanged.

if (
__DEV__ &&
value &&
(value as ComponentInternalInstance).render &&
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the 'setup script', the component value comes from the 'props' or 'setupState', and when it is an object with a render function, can it be considered a component? If it can be judged that it is a component in this way, then report a warning, otherwise leave it as is

@baiwusanyu-c baiwusanyu-c requested a review from edison1105 July 8, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🍰 p2-nice-to-have Priority 2: this is not breaking anything but nice to have it addressed. version: minor wait changes
6 participants