fix(nitro): include layer server directories in tsconfig.server.json #33510

dheeraj3587 · 2025-10-18T09:04:32Z

Fixes #33477

In Nuxt 4.1.3, server files inside layer directories (e.g. layers/*/server/**) were not being included in the generated .nuxt/tsconfig.server.json. This caused TypeScript errors in IDEs such as WebStorm (e.g. Cannot find name 'defineNitroPlugin'), even though the application ran correctly.

This change updates the TypeScript configuration generation to automatically include all layer server directories, matching how Nitro already includes them in its scanDirs configuration.

Changes

Added layer server paths to the include array in .nuxt/tsconfig.server.json
Restored IDE TypeScript support for server files inside layers
Removed the need for manual configuration via nitro.typescript.tsConfig.include

Linked issue

Fixes #33477

Notes

This aligns the handling of layer server directories with the main server directory, improving TypeScript developer experience without affecting runtime behavior.

Fixes an issue where server files inside Nuxt layer directories (e.g., layers/*/server/**) were not automatically included in .nuxt/tsconfig.server.json, causing IDEs to fail type resolution for Nitro types like defineNitroPlugin. Changes: - Add layer server directories to Nitro TypeScript config include - Add test to verify layer server paths are included in tsconfig Closes nuxt#33489

bolt-new-by-stackblitz · 2025-10-18T09:04:36Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-10-18T09:07:13Z

Walkthrough

Updates Nitro/Nuxt build configuration to append TypeScript/JavaScript include globs for each layer's server directory into Nitro's tsconfig include array, using relativeWithDot and the globs **/*.{ts,tsx,mts,cts,js,mjs,cjs}. Adds a test that loads Nuxt with a layers fixture, reads the Nitro tsconfig include entries from Nuxt's internal _nitro options, and asserts a layer server path (e.g. layers/auto/server) is present. No runtime behaviour changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Review changes in packages/nitro-server/src/index.ts to confirm include path construction and glob formatting.
Check the new test packages/nuxt/test/load-nuxt.test.ts for robustness (path normalisation and Nuxt teardown).

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title directly describes the main change: including layer server directories in tsconfig.server.json, which matches the changeset.
Description check	✅ Passed	The description thoroughly explains the bug fix, including the problem, solution, and changes made, all directly related to the code changes.
Linked Issues check	✅ Passed	The pull request successfully addresses the objective from issue #33477: automatically including layer server directories in .nuxt/tsconfig.server.json for IDE TypeScript support.
Out of Scope Changes check	✅ Passed	All changes are directly related to fixing the reported issue; both files modified (index.ts and load-nuxt.test.ts) focus solely on adding layer server paths to TypeScript configuration.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

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 934dc00 and de4c796.

📒 Files selected for processing (2)

packages/nitro-server/src/index.ts (1 hunks)
packages/nuxt/test/load-nuxt.test.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/nitro-server/src/index.ts
packages/nuxt/test/load-nuxt.test.ts

**/*.{test,spec}.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Write unit tests for core functionality using vitest

Files:

packages/nuxt/test/load-nuxt.test.ts

🧬 Code graph analysis (1)

packages/nuxt/test/load-nuxt.test.ts (2)

packages/nuxt/src/core/nuxt.ts (1)

loadNuxt (752-870)

packages/kit/src/loader/nuxt.ts (1)

loadNuxt (18-37)

🪛 GitHub Check: build

packages/nuxt/test/load-nuxt.test.ts

[failure] 149-149:
Property '_nitro' does not exist on type 'Nuxt'.

⏰ 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: codeql (javascript-typescript)
GitHub Check: code

🔇 Additional comments (1)

packages/nitro-server/src/index.ts (1)

217-217: LGTM! Correctly includes layer server directories in TypeScript configuration.

This change aligns TypeScript IDE support with Nitro's runtime scanDirs behaviour (line 180), ensuring server files within layers receive proper type checking. The glob pattern **/* appropriately captures all server files, consistent with the objective to fix IDE TypeScript errors for layer server directories.

packages/nuxt/test/load-nuxt.test.ts

pkg-pr-new · 2025-10-18T09:13:58Z

Open in StackBlitz

@nuxt/kit

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

@nuxt/nitro-server

npm i https://pkg.pr.new/@nuxt/nitro-server@33510

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 7516379

codspeed-hq · 2025-10-18T09:24:58Z

CodSpeed Performance Report

Merging #33510 will not alter performance

_{Comparing dheeraj3587:main (7516379) with main (ec316ea)}

Summary

✅ 10 untouched

The '**/*' glob was causing TypeScript to process all files including non-TS files, leading to performance issues and test timeouts. Changed to match the pattern used for module directories.

Changed from 'dirs.server' to 'dirs.server/**/*.{ts,tsx,mts,cts}' - Ensures subdirectories like server/api/, server/middleware/ are included - Only processes TypeScript files, avoiding performance issues - Matches pattern used for shared directories

cernymatej · 2025-11-02T16:27:01Z

packages/nitro-server/src/index.ts

            ]
          }),
+          ...layerDirs.flatMap((dirs) => {
+            const serverFileGlobs = ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts', '**/*.js', '**/*.mjs', '**/*.cjs']


couldn't we add just the server directory and not the individual extensions?

extensions are configureable from options: example knip https://github.com/webpro-nl/knip/pull/1265/files#diff-94cc8dab409c9b7cd7fc21a94d45b1fd23f3fd3c5eb2a152dea271fa1bbeff59R44

we can combine them into one glob: https://github.com/webpro-nl/knip/pull/1265/files#diff-94cc8dab409c9b7cd7fc21a94d45b1fd23f3fd3c5eb2a152dea271fa1bbeff59R90

danielroe

thank you ❤️

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/nitro-server/src/index.ts (1)
218-218: Consider using specific file extensions in the glob pattern.

Following up on the previous discussion, the current pattern **/* matches all files in layer server directories. For better precision and clarity, consider restricting to server code file extensions.

Based on coding guidelines, this would be clearer and avoid including non-code files (JSON, markdown, etc.):
-          ...layerDirs.map(dirs => relativeWithDot(nuxt.options.buildDir, join(dirs.server, '**/*'))),
+          ...layerDirs.map(dirs => relativeWithDot(nuxt.options.buildDir, join(dirs.server, '**/*.{ts,tsx,mts,cts,js,mjs,cjs}'))),
This aligns with TypeScript best practices and matches the typical server file extensions that Nitro would scan.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74f5823 and 7516379.

📒 Files selected for processing (1)

packages/nitro-server/src/index.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

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

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/nitro-server/src/index.ts

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

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

**/*.{ts,tsx,js,jsx,vue}: Use clear, descriptive variable and function names
Add comments only to explain complex logic or non-obvious implementations
Keep functions focused and manageable (generally under 50 lines), and extract complex logic into separate domain-specific files
Remove code that is not used or needed
Use error handling patterns consistently

Files:

packages/nitro-server/src/index.ts

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: nuxt/nuxt PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T11:42:16.119Z
Learning: Applies to **/*.{test,spec}.{ts,tsx,js} : Write unit tests for core functionality using `vitest`

#33510)

dheeraj3587 added 3 commits October 18, 2025 14:21

Merge branch 'nuxt:main' into main

300f3f7

chore: remove redundant comment from test

de4c796

dheeraj3587 requested a review from danielroe as a code owner October 18, 2025 09:04

github-actions bot added 4.x bug labels Oct 18, 2025

coderabbitai bot reviewed Oct 18, 2025

View reviewed changes

packages/nuxt/test/load-nuxt.test.ts Show resolved Hide resolved

fix(test): add type assertion for _nitro property access

6ba8c31

dheeraj3587 mentioned this pull request Oct 18, 2025

fix(nitro): include layer server directories in tsconfig.server.json #33489

Closed

dheeraj3587 added 3 commits October 23, 2025 19:08

Merge branch 'main' into main

11ab350

fix(nitro): remove overly broad glob pattern from server includes

77e42d0

The '**/*' glob was causing TypeScript to process all files including non-TS files, leading to performance issues and test timeouts. Changed to match the pattern used for module directories.

dheeraj3587 force-pushed the main branch from 918baf7 to 74f5823 Compare October 23, 2025 14:36

cernymatej reviewed Nov 2, 2025

View reviewed changes

danielroe added 2 commits November 25, 2025 13:36

Merge remote-tracking branch 'origin/main' into dheeraj3587/main

39feace

refactor: include all files in server dir (aligning with nitro)

7516379

danielroe approved these changes Nov 25, 2025

View reviewed changes

coderabbitai bot reviewed Nov 25, 2025

View reviewed changes

danielroe merged commit ece3822 into nuxt:main Nov 25, 2025
98 of 100 checks passed

github-actions bot mentioned this pull request Nov 25, 2025

v4.2.2 #33687

Merged

This was referenced Dec 1, 2025

feat(schema): add global tsconfig options #33795

Open

builder:watch hook is not triggered for changes in server/ #33827

Open

danielroe pushed a commit that referenced this pull request Dec 9, 2025

fix(nitro): include layer server directories in tsconfig.server.json (

c470316

#33510)

github-actions bot mentioned this pull request Dec 9, 2025

v3.20.2 #33696

Merged

coderabbitai bot mentioned this pull request Dec 25, 2025

docs: clarify type-checking context limitations for server routes #33964

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nitro): include layer server directories in tsconfig.server.json #33510

fix(nitro): include layer server directories in tsconfig.server.json #33510

Uh oh!

dheeraj3587 commented Oct 18, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Oct 18, 2025

Uh oh!

coderabbitai bot commented Oct 18, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 18, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Oct 18, 2025 •

edited

Loading

Uh oh!

cernymatej Nov 2, 2025

Uh oh!

OrbisK Nov 2, 2025

Uh oh!

danielroe left a comment

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

fix(nitro): include layer server directories in tsconfig.server.json #33510

fix(nitro): include layer server directories in tsconfig.server.json #33510

Uh oh!

Conversation

dheeraj3587 commented Oct 18, 2025

Changes

Linked issue

Notes

Uh oh!

bolt-new-by-stackblitz bot commented Oct 18, 2025

Uh oh!

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

Uh oh!

Walkthrough

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

CodSpeed Performance Report

Merging #33510 will not alter performance

Summary

Uh oh!

cernymatej Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

OrbisK Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Oct 18, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 18, 2025 •

edited

Loading

codspeed-hq bot commented Oct 18, 2025 •

edited

Loading