Skip to content

fix(nuxt): allow camelCase for lazy hydration attributes #32297

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 2 commits into from
Jun 6, 2025
Merged

Conversation

huang-julien
Copy link
Member

🔗 Linked issue

fix #32295

📚 Description

This PR allows users to use PascalCase attribute for lazy hydration

@Copilot Copilot AI review requested due to automatic review settings June 4, 2025 18:49
@huang-julien huang-julien requested a review from danielroe as a code owner June 4, 2025 18:49
Copy link

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

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enables PascalCase lazy-hydration attributes alongside existing kebab-case support.

  • Added tests for PascalCase lazy-hydration props
  • Updated the plugin regex to recognize PascalCase variants

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
packages/nuxt/test/component-loader.test.ts Added PascalCase entries in the lazy hydration tests
packages/nuxt/src/components/plugins/lazy-hydration-transform.ts Extended regex to match PascalCase hydration props

@@ -23,7 +23,9 @@ const hydrationStrategyMap = {
hydrateWhen: 'If',
hydrateNever: 'Never',
}
const LAZY_HYDRATION_PROPS_RE = /\bhydrate-?on-?idle|hydrate-?on-?visible|hydrate-?on-?interaction|hydrate-?on-?media-?query|hydrate-?after|hydrate-?when|hydrate-?never\b/

const LAZY_HYDRATION_PROPS_RE = /\b(?:hydrate-on-idle|HydrateOnIdle|hydrate-on-visible|HydrateOnVisible|hydrate-on-interaction|HydrateOnInteraction|hydrate-on-media-query|HydrateOnMediaQuery|hydrate-after|HydrateAfter|hydrate-when|HydrateWhen|hydrate-never|HydrateNever)\b/
Copy link
Preview

Copilot AI Jun 4, 2025

Choose a reason for hiding this comment

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

[nitpick] The regex is quite repetitive and could become hard to maintain as strategies evolve. Consider consolidating patterns and using a case-insensitive flag with grouped alternations, for example: const LAZY_HYDRATION_PROPS_RE = /\b(?:hydrate(?:-on-(?:idle|visible|interaction|media-query)|-after|-when|-never)|Hydrate(?:On(?:Idle|Visible|Interaction|MediaQuery)|After|When|Never))\b/;

Suggested change
const LAZY_HYDRATION_PROPS_RE = /\b(?:hydrate-on-idle|HydrateOnIdle|hydrate-on-visible|HydrateOnVisible|hydrate-on-interaction|HydrateOnInteraction|hydrate-on-media-query|HydrateOnMediaQuery|hydrate-after|HydrateAfter|hydrate-when|HydrateWhen|hydrate-never|HydrateNever)\b/
const LAZY_HYDRATION_PROPS_RE = new RegExp(
`\\b(?:${Object.keys(hydrationStrategyMap)
.map(key => key.replace(/([A-Z])/g, '-$1').toLowerCase() + '|' + key)
.join('|')})\\b`,
'i'
)

Copilot uses AI. Check for mistakes.

Copy link

coderabbitai bot commented Jun 4, 2025

Walkthrough

The changes update the regular expression in the lazy hydration transform logic to explicitly match hydration-related attributes in both kebab-case and camelCase forms, covering all hydration strategies such as idle, visible, interaction, media-query, after, when, and never. The test suite for lazy hydration components is extended to verify both kebab-case and camelCase prop variants, ensuring correct resolution of lazy hydration component factories for each variant. No other functional logic or exported declarations are modified in these updates.


📜 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 9090573 and 7f8e618.

📒 Files selected for processing (2)
  • packages/nuxt/src/components/plugins/lazy-hydration-transform.ts (1 hunks)
  • packages/nuxt/test/component-loader.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/nuxt/test/component-loader.test.ts
  • packages/nuxt/src/components/plugins/lazy-hydration-transform.ts
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

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)
packages/nuxt/src/components/plugins/lazy-hydration-transform.ts (1)

26-28: Regex expanded correctly—but consider DRYing it out
The updated LAZY_HYDRATION_PROPS_RE now explicitly matches both kebab-case and PascalCase lazy hydration attributes as intended. To reduce duplication and avoid drift when hydrationStrategyMap changes in future, you could programmatically derive this pattern from the map’s keys using kebabCase and pascalCase.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 42114f4 and 9090573.

📒 Files selected for processing (2)
  • packages/nuxt/src/components/plugins/lazy-hydration-transform.ts (1 hunks)
  • packages/nuxt/test/component-loader.test.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (1)
packages/nuxt/test/component-loader.test.ts (1)

133-139: PascalCase hydration props tests added
Great addition—these parameterised tests now cover PascalCase variants and ensure they resolve to the correct lazy hydration components, matching the transform regex update.

Copy link

pkg-pr-new bot commented Jun 4, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 7f8e618

Copy link

codspeed-hq bot commented Jun 4, 2025

CodSpeed Performance Report

Merging #32297 will not alter performance

Comparing fix/32295 (7f8e618) with main (42114f4)

Summary

✅ 10 untouched benchmarks

@huang-julien huang-julien marked this pull request as draft June 4, 2025 19:57
@huang-julien huang-julien changed the title fix(nuxt): allow PascalCase attribute for lazy hydration attributes fix(nuxt): allow camelCase attribute for lazy hydration attributes Jun 4, 2025
@huang-julien huang-julien changed the title fix(nuxt): allow camelCase attribute for lazy hydration attributes fix(nuxt): allow camelCase for lazy hydration attributes Jun 4, 2025
@huang-julien huang-julien marked this pull request as ready for review June 4, 2025 20:02
@danielroe danielroe merged commit d0a61fc into main Jun 6, 2025
48 checks passed
@danielroe danielroe deleted the fix/32295 branch June 6, 2025 04:42
@github-actions github-actions bot mentioned this pull request Jun 3, 2025
@github-actions github-actions bot mentioned this pull request Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
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