Skip to content

fix(nuxt): add warning for lazy-hydration missing prefix #32832

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

Merged
merged 6 commits into from
Aug 4, 2025

Conversation

OskarLebuda
Copy link
Contributor

@OskarLebuda OskarLebuda commented Jul 31, 2025

🔗 Linked issue

resolves #32736

📚 Description

Add a missing warning for components that use the lazy-hydration props but aren't prefixed with <Lazy. This helps catch cases where developers intend to lazy-load a component but forget the naming convention, potentially leading to unexpected behavior.

Example:

<template>
  <SomeComp hydrate-never/>
</template>

Warning:
obraz

@OskarLebuda OskarLebuda requested a review from danielroe as a code owner July 31, 2025 20:52
Copy link

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

Copy link

coderabbitai bot commented Jul 31, 2025

Walkthrough

A conditional warning log has been introduced in the lazy-hydration-transform plugin. The code now checks if a component node possesses lazy-hydration properties but its name does not start with "Lazy", "lazy-", and is not a "template" element. If these conditions are met, a warning is logged suggesting to rename the component to a lazy variant or remove the lazy-hydration properties. This warning is triggered before the existing logic that skips further processing for non-lazy components. The components collection was changed from an array to a Set for more efficient lookup. The warning message includes the component name and relative file path, resolved by reversing aliases including a new stripped alias map. No changes were made to exported or public entity declarations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 0aad8a5 and 10ddea5.

📒 Files selected for processing (1)
  • packages/nuxt/src/components/plugins/lazy-hydration-transform.ts (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/components/plugins/lazy-hydration-transform.ts
⏰ 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: codeql (javascript-typescript)
  • GitHub Check: build
  • GitHub Check: code
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate unit tests to generate unit tests for 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.

Copy link

pkg-pr-new bot commented Jul 31, 2025

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32832

nuxt

npm i https://pkg.pr.new/nuxt@32832

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32832

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32832

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32832

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32832

commit: 10ddea5

Copy link

codspeed-hq bot commented Jul 31, 2025

CodSpeed Performance Report

Merging #32832 will not alter performance

Comparing OskarLebuda:fix/lazy-hydration-warning (10ddea5) with main (052b98a)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 1cb8a64 into nuxt:main Aug 4, 2025
80 of 83 checks passed
@github-actions github-actions bot mentioned this pull request Aug 4, 2025
This was referenced Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warn when using hydration directive without Lazy prefix
3 participants