Skip to content

fix(compiler-dom): improve HTML nesting validation to allow any child element within template tag #13320

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
May 16, 2025

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented May 13, 2025

close #13318

Summary by CodeRabbit

  • Bug Fixes

    • Improved HTML nesting validation to allow any child element within a tag.
    • Tests

      • Added comprehensive tests to verify correct behavior of HTML and SVG element nesting validation, including new scenarios for , tables, forms, and SVG elements.

Copy link

coderabbitai bot commented May 13, 2025

Walkthrough

The changes update the HTML nesting validation logic to allow any child within a <template> element, and extend the test suite with new cases to verify this behavior and comprehensively test the isValidHTMLNesting function across various HTML and SVG tag combinations.

Changes

File(s) Change Summary
packages/compiler-dom/src/htmlNesting.ts Modified isValidHTMLNesting to always return true when the parent is 'template'.
packages/compiler-dom/tests/transforms/validateHtmlNesting.spec.ts
packages/compiler-dom/tests/transforms/htmlNesting.spec.ts
Added and expanded test cases for <template> nesting and for isValidHTMLNesting with various HTML/SVG tag pairs.

Sequence Diagram(s)

sequenceDiagram
    participant Validator as isValidHTMLNesting
    participant Caller as ValidationCaller

    Caller->>Validator: validate(parent, child)
    alt parent is 'template'
        Validator-->>Caller: return true
    else
        Validator->>Validator: check standard HTML nesting rules
        Validator-->>Caller: return true/false
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Remove incorrect warning for <tr> as a child of <template> (#13318)
Ensure <template> allows any child element without restriction (#13318)

Poem

🐇
In a warren of tags, the template stands tall,
Now welcomes all children, both big and small.
No warnings for <tr>, no fuss, no fight—
The validator’s logic now gets it right!
With tests all expanded, the rules are precise,
This patch makes HTML nesting quite nice.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between c489a3e and 8842891.

📒 Files selected for processing (2)
  • packages/compiler-dom/__tests__/transforms/validateHtmlNesting.spec.ts (2 hunks)
  • packages/compiler-dom/src/htmlNesting.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/compiler-dom/__tests__/transforms/validateHtmlNesting.spec.ts (1)
packages/compiler-dom/src/htmlNesting.ts (1)
  • isValidHTMLNesting (13-44)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
🔇 Additional comments (4)
packages/compiler-dom/src/htmlNesting.ts (1)

14-17: Good addition to handle template tag correctly.

This change properly addresses issue #13318 by adding a special case for <template> elements. Since the HTML <template> element is designed to hold inert content that shouldn't be rendered immediately, standard HTML nesting rules don't apply to its children. The early return ensures any child element within a template tag is considered valid.

This matches the HTML specification's behavior and prevents false validation warnings during compilation.

packages/compiler-dom/__tests__/transforms/validateHtmlNesting.spec.ts (3)

2-2: Good addition to import the function being tested.

The import of isValidHTMLNesting is necessary for the new test suite that directly tests this function.


22-29: Good test for the template tag fix.

This test correctly verifies the fix for issue #13318 by confirming that no validation warning is emitted when a <tr> element is placed inside a <template> tag. This is a good targeted test case that directly corresponds to the code change in htmlNesting.ts.


32-201: Excellent comprehensive test suite for HTML nesting validation.

This thorough test suite covers a wide range of HTML element combinations and ensures the isValidHTMLNesting function behaves correctly for both valid and invalid nesting scenarios. The tests are well-organized by element type and clearly separate valid from invalid cases.

The test coverage includes:

  • Basic elements (form, p, a, button)
  • Table-related elements (table, td, tbody, tr)
  • List elements (li)
  • Headings (h1-h6)
  • SVG elements
  • Definition list elements (dl, dt, dd)

This comprehensive approach helps prevent regressions and validates the overall HTML nesting validation logic beyond just the template tag fix.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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

github-actions bot commented May 13, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.3 kB 34.5 kB
vue.global.prod.js 159 kB 58.5 kB 52 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB 18.2 kB 16.7 kB
createApp 54.5 kB 21.2 kB 19.4 kB
createSSRApp 58.8 kB 23 kB 20.9 kB
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.6 kB 26.4 kB 24.1 kB

Copy link

pkg-pr-new bot commented May 13, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/shared

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

vue

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

@vue/compat

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

@vue/server-renderer

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

commit: 8842891

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: compiler 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. need test The PR has missing test cases. labels May 13, 2025
@LittleSound
Copy link
Member

Maybe we can add some unit tests

@edison1105 edison1105 requested review from sxzz and LittleSound May 16, 2025 00:50
@edison1105 edison1105 changed the title fix(compiler-dom): prevent 'template' tag from being validated as parent fix(compiler-dom): prevent template tag from being validated as parent May 16, 2025
@edison1105 edison1105 changed the title fix(compiler-dom): prevent template tag from being validated as parent fix(compiler-dom): improve HTML nesting validation to allow any child element within template tag May 16, 2025
@edison1105 edison1105 removed the need test The PR has missing test cases. label May 16, 2025
@edison1105 edison1105 merged commit 163b365 into main May 16, 2025
16 checks passed
@edison1105 edison1105 deleted the edison/fix/13318 branch May 16, 2025 01:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. ready to merge The PR is ready to be merged. scope: compiler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect warning: <tr> cannot be child of <template>, according to HTML specifications
3 participants