fix(dashboard): Enable dashboard React JSX compilation #3726

hans-rollingridges-dev · 2025-08-02T10:09:41Z

Description

Dashboard compilation is failing because React JSX templates from Vendure plugins are not being emitted during the build process. This prevents the dashboard from loading the necessary React JSX modules.

Breaking changes

Screenshots

Checklist

📌 Always:

I have set a clear title
My PR is small and contains a single feature
I have checked my own PR

👍 Most of the time:

I have added or updated test cases
I have updated the README if needed

Summary by CodeRabbit

Chores
- Updated TypeScript compilation settings to improve React JSX code output.

vercel · 2025-08-02T10:09:45Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	❌ Failed (Inspect)		Aug 2, 2025 10:11am

coderabbitai · 2025-08-02T10:09:52Z

Walkthrough

The compileTypeScript function in the packages/dashboard/vite/utils/compiler.ts file was updated to set the jsx compiler option to ts.JsxEmit.ReactJSX, configuring TypeScript to emit React JSX code. No other changes were made to compiler options or to the function's logic.

Changes

Cohort / File(s)	Change Summary
TypeScript Compiler JSX Option Update `packages/dashboard/vite/utils/compiler.ts`	Added `jsx: ts.JsxEmit.ReactJSX` to the TypeScript compiler options in `compileTypeScript`.

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 3cd5fff and c65d327.

📒 Files selected for processing (1)

packages/dashboard/vite/utils/compiler.ts (1 hunks)

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,jsx} : Use React for all UI components in the dashboard package.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/lib/components/**/*.{tsx,jsx} : Use Shadcn UI and Tailwind CSS for UI components.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,jsx} : Prefer re-using components from /src/lib/components, especially Shadcn components from /src/lib/components/ui.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,ts} : React component props objects should be typed as Readonly<...>.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{ts,tsx} : When performing mutations, follow the provided useMutation pattern: use graphql() for the mutation document, api.mutate for mutationFn, and do not pass variables at declaration.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/app/routes/**/*.tsx : Use TanStack Router for all routing and navigation in the dashboard app.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,jsx} : All labels or user-facing messages should use localization via the Trans component or useLingui().

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{ts,tsx} : When creating useQuery calls, follow the provided pattern: import { api } from '@/graphql/api.js'; import { graphql } from '@/graphql/graphql.js'; use useQuery with queryKey, staleTime, and queryFn using api.query.

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{ts,tsx} : Use TanStack Query (useQuery or useMutation) for data fetching; do not use Apollo Client.

📚 Learning: applies to packages/dashboard/src/**/*.{tsx,jsx} : use react for all ui components in the dashboard ...

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,jsx} : Use React for all UI components in the dashboard package.

Applied to files:

packages/dashboard/vite/utils/compiler.ts

📚 Learning: applies to packages/dashboard/src/lib/components/**/*.{tsx,jsx} : use shadcn ui and tailwind css for...

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/lib/components/**/*.{tsx,jsx} : Use Shadcn UI and Tailwind CSS for UI components.

Applied to files:

packages/dashboard/vite/utils/compiler.ts

📚 Learning: applies to packages/dashboard/src/**/*.{tsx,jsx} : prefer re-using components from /src/lib/componen...

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,jsx} : Prefer re-using components from /src/lib/components, especially Shadcn components from /src/lib/components/ui.

Applied to files:

packages/dashboard/vite/utils/compiler.ts

📚 Learning: applies to packages/dashboard/src/**/*.{ts,tsx} : when performing mutations, follow the provided use...

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{ts,tsx} : When performing mutations, follow the provided useMutation pattern: use graphql() for the mutation document, api.mutate for mutationFn, and do not pass variables at declaration.

Applied to files:

packages/dashboard/vite/utils/compiler.ts

📚 Learning: applies to packages/dashboard/src/**/*.{tsx,ts} : react component props objects should be typed as r...

Learnt from: CR
PR: vendure-ecommerce/vendure#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-23T07:05:04.344Z
Learning: Applies to packages/dashboard/src/**/*.{tsx,ts} : React component props objects should be typed as Readonly<...>.

Applied to files:

packages/dashboard/vite/utils/compiler.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). (20)

GitHub Check: e2e tests (24.x, mysql)
GitHub Check: e2e tests (20.x, mysql)
GitHub Check: e2e tests (22.x, sqljs)
GitHub Check: e2e tests (24.x, sqljs)
GitHub Check: e2e tests (22.x, postgres)
GitHub Check: e2e tests (22.x, mariadb)
GitHub Check: e2e tests (20.x, mariadb)
GitHub Check: e2e tests (20.x, postgres)
GitHub Check: unit tests (24.x)
GitHub Check: unit tests (22.x)
GitHub Check: publish_install (windows-latest, 24.x)
GitHub Check: build (22.x)
GitHub Check: build (24.x)
GitHub Check: build (20.x)
GitHub Check: unit tests (20.x)
GitHub Check: publish_install (macos-latest, 24.x)
GitHub Check: publish_install (macos-latest, 22.x)
GitHub Check: publish_install (macos-latest, 20.x)
GitHub Check: publish_install (ubuntu-latest, 20.x)
GitHub Check: publish_install (windows-latest, 24.x)

🔇 Additional comments (1)

packages/dashboard/vite/utils/compiler.ts (1)

153-159: Verify availability of react/jsx-runtime at runtime

Setting jsx: ts.JsxEmit.ReactJSX enables the automatic JSX transform, which rewrites JSX to calls into react/jsx-runtime.
If the server process that imports the compiled files runs without a react dependency (or with a version < 17), the import will fail at runtime.

Please double-check that:

A compatible react package is listed in the workspace root or the CLI package that loads these compiled files.

Any downstream bundler (e.g. Vite) still receives un-transpiled JSX where required, or, if everything is pre-compiled here, that the bundles include the jsx-runtime import.

If both conditions are satisfied, the change looks good. Otherwise consider falling back to React emit or adding a peerDependency on react.

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

github-actions · 2025-08-02T10:09:53Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

sonarqubecloud · 2025-08-02T10:10:52Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

hans-rollingridges-dev · 2025-08-02T10:11:49Z

I have read the CLA Document and I hereby sign the CLA

dlhck · 2025-08-02T13:46:32Z

This should not be necessary, as we are processing the JSX differently. The compilation in that case is only for the Vendure config and plugins discovery. Can you please open an issue and add a minimal reproduction repo of your setup, where it is not able to find the extensions?

hans-rollingridges-dev · 2025-08-02T14:13:40Z

You're right, this shouldn't be necessary. However, the dashboard compilation is failing because it tries to process React JSX from the Vendure plugins themselves, not from the dashboard's own code. For example, plugins that use React for rendering rich-text emails or PDF invoices are causing the build to fail.

Should a reproduction still be needed, I can create a minimal example. I'll use a clean npx @vendure/create my-shop setup and add a simple plugin with a React render-to-PDF component.

hans-rollingridges-dev · 2025-08-02T14:18:33Z

I removed the word "extensions" from the title because it is rather confusing in this context.

dlhck · 2025-08-02T14:22:06Z

Thank you for the detailed information, that helps us a lot! We'll look into that!

hans-rollingridges-dev · 2025-08-02T14:29:56Z

FYI, I only tested the proposed compile option jsx: ts.JsxEmit.ReactJSX, by directly modifying the installed Vendure dashboard package within the node_modules directory.

hans-rollingridges-dev · 2025-08-02T14:39:51Z

It's also worth noting that in my test project, I've overridden the react dependency in the package.json to match the version used in @vendure.

fix(dashboard): Enable dashboard extensions React JSX compilation

c65d327

vercel bot had a problem deploying to Preview August 2, 2025 10:11 Failure

github-actions bot added a commit that referenced this pull request Aug 2, 2025

@hans-rollingridges-dev has signed the CLA in #3726

35cfd86

hans-rollingridges-dev changed the title ~~fix(dashboard): Enable dashboard extensions React JSX compilation~~ fix(dashboard): Enable dashboard React JSX compilation Aug 2, 2025

dlhck added this to the v3.4.1 milestone Aug 2, 2025

michaelbromley added the @vendure/dashboard label Aug 25, 2025

michaelbromley modified the milestones: v3.4.1, v3.4.2 Aug 25, 2025

fix(dashboard): Enable dashboard React JSX compilation #3726

Are you sure you want to change the base?

fix(dashboard): Enable dashboard React JSX compilation #3726

Conversation

hans-rollingridges-dev commented Aug 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking changes

Screenshots

Checklist

Summary by CodeRabbit

Uh oh!

vercel bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Aug 2, 2025

Quality Gate passed

Uh oh!

hans-rollingridges-dev commented Aug 2, 2025

Uh oh!

dlhck commented Aug 2, 2025

Uh oh!

hans-rollingridges-dev commented Aug 2, 2025

Uh oh!

hans-rollingridges-dev commented Aug 2, 2025

Uh oh!

dlhck commented Aug 2, 2025

Uh oh!

hans-rollingridges-dev commented Aug 2, 2025

Uh oh!

hans-rollingridges-dev commented Aug 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hans-rollingridges-dev commented Aug 2, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 2, 2025 •

edited

Loading

coderabbitai bot commented Aug 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Aug 2, 2025 •

edited

Loading