fix(vite): include tsconfig references during `typeCheck` #32835

BobbieGoede · 2025-08-01T10:14:01Z

🔗 Linked issue

[v4]: typecheck on build does not work #32823

📚 Description

Resolves #32823

@danielroe
The type checking is not using the -b argument, so no type errors are reported in projects using the new tsconfig structure.

We should probably check if the project is using tsconfig references and enable buildMode based on that.

This seems to work, but it seems to report type errors in server routes twice 🤔, it also adds tsconfig.*.tsbuildinfo files in .nuxt for each tsconfig file it contains which may be undesirable.

bolt-new-by-stackblitz · 2025-08-01T10:14:05Z

Run & review this pull request in StackBlitz Codeflow.

danielroe · 2025-08-01T10:15:38Z

we probably need to do this only when the user has the new references format tsconfig.

pkg-pr-new · 2025-08-01T10:17:58Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: a2d28f0

codspeed-hq · 2025-08-01T10:29:35Z

CodSpeed Performance Report

Merging #32835 will not alter performance

_{Comparing BobbieGoede:fix/type-check-tsconfig-references (a2d28f0) with main (3a66515)}

Summary

✅ 10 untouched benchmarks

coderabbitai · 2025-08-01T10:34:25Z

Walkthrough

The changes update the logic within the bundle function in the Vite package to optimise how the TypeScript configuration is handled. The code now imports readTSConfig in addition to resolveTSConfig and resolves the TypeScript configuration path only once. It reads the TypeScript configuration to check for project references, storing this as a boolean. This value is then used to set the buildMode option in the vite-plugin-checker configuration. The previous approach resolved the configuration path twice and did not set the buildMode option.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

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

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

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3a66515 and a2d28f0.

📒 Files selected for processing (1)

packages/vite/src/vite.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/vite/src/vite.ts

🧠 Learnings (9)

📓 Common learnings

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

Learnt from: TheAlexLichter
PR: nuxt/nuxt#31812
File: packages/nuxt/src/components/plugins/islands-transform.ts:202-202
Timestamp: 2025-04-18T18:33:41.753Z
Learning: In Nuxt, using `rolldownVersion` (not `rollupVersion`) is intentional when detecting if rolldown-vite is being used, even though TypeScript may show an error because the property isn't in standard type definitions yet.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.{test,spec}.{ts,tsx,js,jsx} : Write unit tests for core functionality using `vitest`

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.vue : Use `<script setup lang="ts">` and the composition API when creating Vue components

📚 Learning: in `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distdir` are l...

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Applied to files:

packages/vite/src/vite.ts

📚 Learning: applies to **/*.{test,spec}.{ts,tsx,js,jsx} : write unit tests for core functionality using `vitest`...

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.{test,spec}.{ts,tsx,js,jsx} : Write unit tests for core functionality using `vitest`

Applied to files:

packages/vite/src/vite.ts

📚 Learning: applies to **/*.{ts,tsx} : follow standard typescript conventions and best practices...

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

Applied to files:

packages/vite/src/vite.ts

📚 Learning: in `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally im...

Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.

Applied to files:

packages/vite/src/vite.ts

📚 Learning: in `packages/kit/src/template.ts`, when updating the `extension_re` regular expression for typescrip...

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Applied to files:

packages/vite/src/vite.ts

📚 Learning: applies to **/*.vue : use `<script setup lang="ts">` and the composition api when creating vue compo...

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.vue : Use `<script setup lang="ts">` and the composition API when creating Vue components

Applied to files:

packages/vite/src/vite.ts

📚 Learning: in nuxt, using `rolldownversion` (not `rollupversion`) is intentional when detecting if rolldown-vit...

Learnt from: TheAlexLichter
PR: nuxt/nuxt#31812
File: packages/nuxt/src/components/plugins/islands-transform.ts:202-202
Timestamp: 2025-04-18T18:33:41.753Z
Learning: In Nuxt, using `rolldownVersion` (not `rollupVersion`) is intentional when detecting if rolldown-vite is being used, even though TypeScript may show an error because the property isn't in standard type definitions yet.

Applied to files:

packages/vite/src/vite.ts

📚 Learning: applies to **/e2e/**/*.{ts,js} : write end-to-end tests using playwright and `@nuxt/test-utils`...

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/e2e/**/*.{ts,js} : Write end-to-end tests using Playwright and `@nuxt/test-utils`

Applied to files:

packages/vite/src/vite.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: test-fixtures (windows-latest, built, webpack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-off, json, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, rspack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, webpack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 20)
GitHub Check: release-pkg-pr-new
GitHub Check: test-benchmark
GitHub Check: test-size
GitHub Check: typecheck (windows-latest, bundler)
GitHub Check: code

🔇 Additional comments (2)

packages/vite/src/vite.ts (2)

11-11: LGTM! Import addition aligns with new functionality.

The addition of readTSConfig import is necessary for the new logic that detects tsconfig references.

192-193: Excellent conditional buildMode implementation!

The implementation correctly addresses the PR objectives by:

Using the resolved tsconfigPath to avoid duplicate resolution

Setting buildMode based on tsconfig references detection

Following the suggestion from danielroe to apply the fix conditionally

This should resolve the type checking issues in projects using tsconfig references structure whilst avoiding unnecessary buildMode activation in projects without references.

packages/vite/src/vite.ts

BobbieGoede · 2025-08-01T10:35:25Z

we probably need to do this only when the user has the new references format tsconfig.

I figured this was checked somewhere already but couldn't find it so I adapted the checking logic from nuxt-cli.

Type checking (in projects with tsconfig references) seems to report server route errors twice, not sure how to prevent that from happening 🤔 still better than no errors at all though

BobbieGoede · 2025-08-01T10:44:13Z

Nevermind, the double error reporting may have been caused by a stray tsconfig.tsbuildinfo in the root of the project (may have been created during earlier tests). It looks like this is working fine

packages/vite/src/vite.ts

danielroe

❤️

fix: typeCheck should check tsconfig references

66a2eab

github-actions bot added 4.x bug labels Aug 1, 2025

BobbieGoede changed the title ~~fix: typeCheck should check tsconfig references~~ fix(vite): include tsconfig references during typeCheck Aug 1, 2025

fix: check if project using ts projects

a2d28f0

BobbieGoede marked this pull request as ready for review August 1, 2025 10:31

BobbieGoede requested a review from danielroe as a code owner August 1, 2025 10:31

coderabbitai bot reviewed Aug 1, 2025

View reviewed changes

packages/vite/src/vite.ts Show resolved Hide resolved

danielroe reviewed Aug 2, 2025

View reviewed changes

packages/vite/src/vite.ts Show resolved Hide resolved

danielroe approved these changes Aug 2, 2025

View reviewed changes

danielroe merged commit 5f6cc15 into nuxt:main Aug 2, 2025
46 checks passed

github-actions bot mentioned this pull request Aug 2, 2025

v4.0.3 #32798

Merged

danielroe pushed a commit that referenced this pull request Aug 4, 2025

fix(vite): include tsconfig references during typeCheck (#32835)

aa82ca2

This was referenced Aug 5, 2025

v3.18.1 #32860

Merged

v4.0.4 #32862

Closed

chrisbbreuer mentioned this pull request Aug 15, 2025

chore(deps): update dependency @nuxt/kit to 4.0.3 stacksjs/ts-maps#43

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(vite): include tsconfig references during `typeCheck` #32835

fix(vite): include tsconfig references during `typeCheck` #32835

Uh oh!

BobbieGoede commented Aug 1, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Aug 1, 2025

Uh oh!

danielroe commented Aug 1, 2025

Uh oh!

pkg-pr-new bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Aug 1, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 1, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

BobbieGoede commented Aug 1, 2025

Uh oh!

BobbieGoede commented Aug 1, 2025

Uh oh!

Uh oh!

danielroe left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(vite): include tsconfig references during typeCheck #32835

fix(vite): include tsconfig references during typeCheck #32835

Uh oh!

Conversation

BobbieGoede commented Aug 1, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Aug 1, 2025

Uh oh!

danielroe commented Aug 1, 2025

Uh oh!

pkg-pr-new bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq bot commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #32835 will not alter performance

Summary

Uh oh!

coderabbitai bot commented Aug 1, 2025

Walkthrough

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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BobbieGoede commented Aug 1, 2025

Uh oh!

BobbieGoede commented Aug 1, 2025

Uh oh!

Uh oh!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fix(vite): include tsconfig references during `typeCheck` #32835

fix(vite): include tsconfig references during `typeCheck` #32835

pkg-pr-new bot commented Aug 1, 2025 •

edited

Loading

codspeed-hq bot commented Aug 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)