Skip to content

docs: mention autoimport resolveComponent only works with literal strings #31511

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
Merged
merged 3 commits into from
Mar 25, 2025
Merged

docs: mention autoimport resolveComponent only works with literal strings #31511

merged 3 commits into from
Mar 25, 2025

Conversation

huang-julien
Copy link
Member

🔗 Linked issue

fix #31503

📚 Description

Docs are maybe not clear enough that autoimports only accept literal strings

@huang-julien huang-julien requested a review from danielroe as a code owner March 23, 2025 18:54
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@danielroe
Copy link
Member

i think we could probably support string templates without interpolation

maybe update this to indicate that the issue is that the string must be statically analysed?

and i can create a pr to support templates

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 23, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation has been updated to clarify the usage of the resolveComponent function in Vue. It specifies that the component name must be a literal string, explicitly stating that variables or dynamic expressions are not permitted. The update also indicates that this string is statically analysed during the compilation step. No modifications were made to the declarations of exported or public entities in this update.

📜 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 3c0b573 and bef5683.

📒 Files selected for processing (1)
  • docs/2.guide/2.directory-structure/1.components.md (1 hunks)
🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Mar 23, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/2.guide/2.directory-structure/1.components.md (1)

81-84: Clarify Autoimport Limitations in resolveComponent

The newly added line in the ::important block clearly explains that autoimports only work with literal strings, which should help avoid confusion. However, consider a slight rephrasing for grammatical consistency. For example, you might change it to:
“Autoimports only work with literal strings and do not accept any operations or template strings within resolveComponent.”

This minor adjustment could improve readability.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...late strings within resolveComponent. :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 36e5cfd and 39c2b6b.

📒 Files selected for processing (1)
  • docs/2.guide/2.directory-structure/1.components.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.guide/2.directory-structure/1.components.md

[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...late strings within resolveComponent. :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (1)
docs/2.guide/2.directory-structure/1.components.md (1)

92-99: Review the Updated Global Components Configuration Example

The diff block now adds global: true and dirs: ['~/components'] to the components configuration in the Nuxt config snippet. This update appears to modernise the example by explicitly enabling global registration and specifying the directory for auto-imports. Please confirm that this example aligns with the current recommended practices and that any related documentation elsewhere reflects this update.

@huang-julien
Copy link
Member Author

huang-julien commented Mar 23, 2025 •
edited
Loading

I don't really see the point of template string without any interpolation 🤔. Wouldn't handling it make the regex more complex (to read) ?

it's already quite long /(?<=[ (])_?resolveComponent\(\s*["'](lazy-|Lazy(?=[A-Z]))?(Idle|Visible|idle-|visible-|Interaction|interaction-|MediaQuery|media-query-|If|if-|Never|never-|Time|time-)?([^'"]*)["'][^)]*\)/g 😅

coderabbitai[bot]
coderabbitai bot reviewed Mar 23, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/2.guide/2.directory-structure/1.components.md (1)

81-84: Documentation Clarity in the resolveComponent Section:
The additional guidance is very helpful in clarifying that only literal strings should be provided to resolveComponent. However, a minor grammatical improvement is suggested on line 83. The static analysis hint notes that adding the article “the” before “compilation step” would improve clarity. Consider applying the following change:

- The string is statically analysed at compilation step.
+ The string is statically analysed at the compilation step.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ...e. The string is statically analyzed at compilation step. :: ::tip{icon="i-lucide-video" t...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...tatically analyzed at compilation step. :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 39c2b6b and 3c0b573.

📒 Files selected for processing (1)
  • docs/2.guide/2.directory-structure/1.components.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2.guide/2.directory-structure/1.components.md

[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ...e. The string is statically analyzed at compilation step. :: ::tip{icon="i-lucide-video" t...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...tatically analyzed at compilation step. :: ::tip{icon="i-lucide-video" to="https...

(UNLIKELY_OPENING_PUNCTUATION)

danielroe
danielroe reviewed Mar 25, 2025
View reviewed changes
@danielroe danielroe merged commit 92cd257 into main Mar 25, 2025
3 of 5 checks passed
@danielroe danielroe deleted the docs/resolve_component_template_string branch March 25, 2025 10:01
@github-actions github-actions bot mentioned this pull request Mar 25, 2025
Draft
danielroe pushed a commit that referenced this pull request Mar 25, 2025
@huang-julien @danielroe
docs: resolveComponent only auto-imports components with literal st…
f7ca9ca 
…rings (#31511)
@github-actions github-actions bot mentioned this pull request Mar 25, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

resolveComponent() doesn't accept template string
2 participants
@huang-julien @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy