Skip to content

chore: export jsxs type #13463

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 1 commit into from
Jun 13, 2025
Merged

chore: export jsxs type #13463

merged 1 commit into from
Jun 13, 2025

Conversation

linzhe141
Copy link
Contributor

@linzhe141 linzhe141 commented Jun 11, 2025

According to this PR #7959, I think we should export jsxs type to avoid type errors in ts

For example, a type error will occur when using it like this
https://www.typescriptlang.org/play/?ts=5.8.3#code/JYWwDg9gTgLgBAbzgCzgXzgMyhEcDkyAhgM4wkDGUwYM+AUKJLInDBAFIkAeASgK4A7GKACm6LDjyFSMALT8RAGzns5AKx5yoQkSFEMm0eEgBiUIgHN9wgDRxN3e45ITsuAgDd+ogPSPtXTF8OF9fOABBTyJgJSIAIyVxEmBBCnEAA29RAAEAZgA6PIyC+np2Lj4g-QAKZBrCAEZ8e0JgAEJ8AEp7BHo4OHMrGxhbfoceMYGXKbhRJJGImBhqeMVRADkifQBhUlEALgJkGBAlBjQuoA

Summary by CodeRabbit

  • New Features
    • Added support for the jsxs function in the JSX runtime, enabling improved handling of JSX elements with multiple children.

Copy link

coderabbitai bot commented Jun 11, 2025

Walkthrough

The type declaration file for the Vue JSX runtime was updated to export the h function as jsxs in addition to the existing exports. This change aligns the exports with JSX runtime conventions by supporting both jsx and jsxs for handling single and multiple children scenarios.

Changes

File Change Summary
packages/vue/jsx-runtime/index.d.ts Updated export statement to include h as jsxs alongside other exports

Poem

In the garden of code where the JSX grows,
A new sprout appears—now jsxs also shows!
With h at the helm for both single and more,
Our runtime is ready for children galore.
🐇✨

✨ 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

pkg-pr-new bot commented Jun 11, 2025

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: a78d3df

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.4 kB 34.6 kB
vue.global.prod.js 159 kB 58.5 kB 52.2 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.7 kB 18.2 kB 16.7 kB
createApp 54.6 kB 21.3 kB 19.4 kB
createSSRApp 58.9 kB 23 kB 21 kB
defineCustomElement 59.6 kB 22.9 kB 20.9 kB
overall 68.7 kB 26.4 kB 24.1 kB

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/vue/jsx-runtime/index.d.ts (1)

4-8: Update the comment block to mention jsxs.

The documentation above still talks only about jsx / jsxDEV. Adding jsxs to the comment keeps the declaration self-documenting and avoids confusion for consumers skimming the header.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cdffaf6 and a78d3df.

📒 Files selected for processing (1)
  • packages/vue/jsx-runtime/index.d.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
  • GitHub Check: test / unit-test-windows
  • GitHub Check: test / e2e-test
  • GitHub Check: continuous-release
🔇 Additional comments (1)
packages/vue/jsx-runtime/index.d.ts (1)

9-9:

✅ Verification successful

Types added—verify runtime export exists to avoid mismatched runtime errors.

The extra alias h as jsxs is the right fix for the type-checker 👍.
Please double-check that the compiled runtime module (packages/vue/jsx-runtime/index.js / dist build) actually exports jsxs; otherwise users will get a runtime Property 'jsxs' does not exist despite the typings compiling fine.

You can run the quick check below:


🏁 Script executed:

#!/usr/bin/env bash
# Look for an exported `jsxs` symbol in the built runtime.
fd -e js -E '*.d.ts' 'jsx-runtime' \
  | xargs -I{} grep -nH "jsxs" {}

Length of output: 68


🏁 Script executed:

#!/usr/bin/env bash
# Locate compiled JS files in jsx-runtime and verify `jsxs` export
set -euo pipefail

# Find all .js files in the jsx-runtime package
js_files=$(fd -e js packages/vue/jsx-runtime)

if [[ -z "$js_files" ]]; then
  echo "No JS files found in packages/vue/jsx-runtime"
  exit 1
fi

echo "JS runtime files found:"
echo "$js_files"
echo

echo "Searching for any occurrences of 'jsxs' in these files..."
echo "$js_files" | xargs -r grep -nH "jsxs" || echo "❌ No occurrences of 'jsxs' found in compiled JS."

echo
echo "Searching specifically for an export statement of 'jsxs'..."
grep -R "export.*jsxs" -n packages/vue/jsx-runtime || echo "❌ No 'export .* jsxs' found."

Length of output: 470


🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "Looking for any occurrence of 'jsxs' in the compiled runtime sources under packages/vue/jsx-runtime…"
if [ -d packages/vue/jsx-runtime ]; then
  grep -R "jsxs" -n packages/vue/jsx-runtime || echo "❌ No occurrences of 'jsxs' found in packages/vue/jsx-runtime"
else
  echo "❌ Directory packages/vue/jsx-runtime not found"
  exit 1
fi

Length of output: 580


Confirmed: jsxs is exported in the runtime build

Verified in both CommonJS and ESM outputs—no further action required to avoid mismatched runtime errors.

Files and locations:

  • packages/vue/jsx-runtime/index.js (line 13):
    exports.jsxs = jsx
  • packages/vue/jsx-runtime/index.mjs (line 12):
    export { Fragment, jsx, jsx as jsxs, jsx as jsxDEV }

@edison1105 edison1105 added scope: types 🧹 p1-chore Priority 1: this doesn't change code behavior. easy to merge labels Jun 13, 2025
@edison1105 edison1105 merged commit c7d3207 into vuejs:main Jun 13, 2025
14 checks passed
@linzhe141 linzhe141 deleted the feat-add-jsxs-typ branch June 16, 2025 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧹 p1-chore Priority 1: this doesn't change code behavior. easy to merge scope: types
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants