fix(nuxt): add `nuxt.schema` files to node tsconfig context #32644

danielroe · 2025-07-16T16:33:46Z

🔗 Linked issue

resolves #32642

📚 Description

this adds nuxt.schema.* files to the node tsconfig context.

bolt-new-by-stackblitz · 2025-07-16T16:33:49Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-16T16:35:26Z

Walkthrough

The import statement for the pathe module was updated to include the join and relative functions in addition to resolve. In the prepare:types hook, the code now checks if ctx.nodeTsConfig.include is defined and initialises it as an array if not. It then adds two relative path patterns to this array: one for nuxt.schema.* files in the root directory and another for such files within any layers/* subdirectories, both relative to the build directory. No changes were made to exported or public entity declarations.

📜 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 8411f94 and de12aee.

📒 Files selected for processing (1)

packages/nuxt/src/core/schema.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

**/*.{ts,tsx,vue}

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

.github/copilot-instructions.md

🧠 Learnings (2)

📓 Common learnings

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: 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: 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: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
Learning: Applies to **/*.{ts,tsx} : Follow standard TypeScript conventions and best practices

packages/nuxt/src/core/schema.ts (5)

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: 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: 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: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-30T13:48:28.134Z
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-06-30T13:48:28.134Z
Learning: Applies to **/*.vue : Use `<script setup lang="ts">` and the composition API when creating Vue components

⏰ 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). (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (2)

packages/nuxt/src/core/schema.ts (2)

4-4: Import additions are correctly aligned with usage below.

The added join and relative functions from pathe are properly imported and used in the new tsconfig include logic.

37-42: Schema file patterns correctly added to node tsconfig context.

The implementation properly:

Initialises ctx.nodeTsConfig.include as an array if undefined using logical OR assignment

Adds relative paths for both root directory and layers subdirectory schema files

Uses relative() to ensure paths are relative to the build directory

Covers the wildcard pattern nuxt.schema.* for various file extensions

This addresses the PR objective of including schema files in the TypeScript configuration context.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/schema-include

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

pkg-pr-new · 2025-07-16T16:39:56Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: de12aee

codspeed-hq · 2025-07-16T16:49:57Z

CodSpeed Performance Report

Merging #32644 will not alter performance

_{Comparing fix/schema-include (de12aee) with main (8411f94)}

Summary

✅ 10 untouched benchmarks

fix(nuxt): add nuxt.schema files to node tsconfig context

9d9c08f

github-actions bot added 4.x bug labels Jul 16, 2025

fix: also add layer paths

de12aee

danielroe merged commit 365e81c into main Jul 17, 2025
117 of 120 checks passed

danielroe deleted the fix/schema-include branch July 17, 2025 14:09

This was referenced Jul 17, 2025

v4.0.1 #32641

Merged

v4.0.1 #32705

Closed

larbish mentioned this pull request Jul 21, 2025

TS error: cannot find defineNuxtSchema nuxt-ui-pro/docs#227

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(nuxt): add `nuxt.schema` files to node tsconfig context #32644

fix(nuxt): add `nuxt.schema` files to node tsconfig context #32644

Uh oh!

danielroe commented Jul 16, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 16, 2025

Uh oh!

coderabbitai bot commented Jul 16, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 16, 2025

Uh oh!

codspeed-hq bot commented Jul 16, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): add nuxt.schema files to node tsconfig context #32644

fix(nuxt): add nuxt.schema files to node tsconfig context #32644

Uh oh!

Conversation

danielroe commented Jul 16, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 16, 2025

Uh oh!

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

Uh oh!

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 16, 2025

Uh oh!

codspeed-hq bot commented Jul 16, 2025

CodSpeed Performance Report

Merging #32644 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

fix(nuxt): add `nuxt.schema` files to node tsconfig context #32644

fix(nuxt): add `nuxt.schema` files to node tsconfig context #32644

coderabbitai bot commented Jul 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)