fix(kit): ensure legacy tsConfig doesn't exclude too many types #32528

danielroe · 2025-07-02T16:19:50Z

🔗 Linked issue

resolves #32519
#32485 (comment)

📚 Description

this includes a number of type related fixes following #32343:

we now have a separate tsconfig.shared.json to govern the shared/ folder
we now ensure that the legacy tsconfig.json doesn't exclude too many types

bolt-new-by-stackblitz · 2025-07-02T16:19:54Z

Run & review this pull request in StackBlitz Codeflow.

pkg-pr-new · 2025-07-02T16:27:52Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: f3331ee

codspeed-hq · 2025-07-02T16:37:59Z

CodSpeed Performance Report

Merging #32528 will not alter performance

_{Comparing fix/tsconfig-includes (f3331ee) with main (404cf55)}

Summary

✅ 10 untouched benchmarks

coderabbitai · 2025-07-02T21:53:25Z

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces a new TypeScript configuration file, .nuxt/tsconfig.shared.json, across the Nuxt codebase and documentation. The shared configuration is intended for code and types used in both app and server contexts, distinct from environment-specific configurations. The core logic for generating and managing TypeScript configs is updated to support this shared context, including path resolution, references, and declaration file generation. Documentation, migration guides, and example tsconfig.json files are updated to reference the new shared config. Additional tests are added for path resolution, and type declarations and hook signatures are extended to accommodate the shared TypeScript context.

📜 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 404cf55 and f3331ee.

📒 Files selected for processing (25)

docs/1.getting-started/18.upgrade.md (2 hunks)
docs/2.guide/1.concepts/8.typescript.md (1 hunks)
docs/2.guide/2.directory-structure/3.tsconfig.md (2 hunks)
docs/7.migration/2.configuration.md (1 hunks)
packages/kit/src/template.ts (10 hunks)
packages/kit/test/generate-types.spec.ts (2 hunks)
packages/nuxt/src/core/nuxt.ts (1 hunks)
packages/nuxt/src/core/schema.ts (1 hunks)
packages/nuxt/src/core/templates.ts (2 hunks)
packages/nuxt/types.d.mts (1 hunks)
packages/nuxt/types.d.ts (1 hunks)
packages/schema/src/types/hooks.ts (1 hunks)
packages/schema/src/types/schema.ts (1 hunks)
playground/tsconfig.json (1 hunks)
test/fixtures/basic-types/nuxt.config.ts (0 hunks)
test/fixtures/basic-types/tsconfig.json (1 hunks)
test/fixtures/basic/tsconfig.json (1 hunks)
test/fixtures/hmr/tsconfig.json (1 hunks)
test/fixtures/minimal-pages/tsconfig.json (1 hunks)
test/fixtures/minimal-types/tsconfig.json (1 hunks)
test/fixtures/minimal/tsconfig.json (1 hunks)
test/fixtures/runtime-compiler/tsconfig.json (1 hunks)
test/fixtures/spa-loader/tsconfig.json (1 hunks)
test/fixtures/suspense/tsconfig.json (1 hunks)
test/nuxt/tsconfig.json (1 hunks)

✨ 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/tsconfig-includes

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.

danielroe added 5 commits July 2, 2025 16:32

fix(kit): ensure legacy tsConfig doesn't exclude too many types

def1367

fix(kit): add shared declarations to nitro + nuxt contexts

1e8a250

test: add generateTypes test

d5f25aa

fix(kit): update global declarations

1575aac

Merge remote-tracking branch 'origin/main' into fix/tsconfig-includes

f3331ee

danielroe self-assigned this Jul 2, 2025

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

danielroe marked this pull request as ready for review July 2, 2025 21:51

danielroe merged commit 69345c3 into main Jul 2, 2025
84 of 87 checks passed

danielroe deleted the fix/tsconfig-includes branch July 2, 2025 21:51

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

v4.0.0 #27716

Merged

danielroe mentioned this pull request Jul 25, 2025

fix(nuxt): constrain global defineAppConfig type #32760

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(kit): ensure legacy tsConfig doesn't exclude too many types #32528

fix(kit): ensure legacy tsConfig doesn't exclude too many types #32528

Uh oh!

danielroe commented Jul 2, 2025

Uh oh!

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

Uh oh!

pkg-pr-new bot commented Jul 2, 2025

Uh oh!

codspeed-hq bot commented Jul 2, 2025

Uh oh!

Uh oh!

coderabbitai bot commented Jul 2, 2025

Review failed

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

fix(kit): ensure legacy tsConfig doesn't exclude too many types #32528

fix(kit): ensure legacy tsConfig doesn't exclude too many types #32528

Uh oh!

Conversation

danielroe commented Jul 2, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

pkg-pr-new bot commented Jul 2, 2025

Uh oh!

codspeed-hq bot commented Jul 2, 2025

CodSpeed Performance Report

Merging #32528 will not alter performance

Summary

Uh oh!

Uh oh!

coderabbitai bot commented Jul 2, 2025

Review failed

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

CodeRabbit Configuration File (`.coderabbit.yaml`)