fix(nuxt): augment runtime config in server context #32482

danielroe · 2025-06-26T12:55:59Z

🔗 Linked issue

📚 Description

Spotted while testing #30665.

bolt-new-by-stackblitz · 2025-06-26T12:56:03Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-06-26T12:57:15Z

Walkthrough

The changes update the Nuxt core templates related to runtime configuration typings. In the schemaTemplate, imports and module declarations are revised to import RuntimeConfig and PublicRuntimeConfig as user-specific types from 'nuxt/schema', and module augmentation is applied to '@nuxt/schema' for these interfaces. The single module declaration for 'nuxt/schema' is split into two separate declarations: one for '@nuxt/schema' with empty extensions, and one for 'nuxt/schema' containing generated types. The type of the $config property on Vue's ComponentCustomProperties is also updated. In nitroSchemaTemplate, a reference directive is changed to point to "./runtime-config.d.ts".

📜 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 67cf2bf and 6509d83.

📒 Files selected for processing (1)

packages/nuxt/src/core/templates.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.ts`: Follow standard TypeScript conventions and best practices

**/*.ts: Follow standard TypeScript conventions and best practices

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

List of files the instruction was applied to:

packages/nuxt/src/core/templates.ts

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

packages/nuxt/src/core/templates.ts (3)

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.

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: codeql (javascript-typescript)
GitHub Check: codeql (actions)
GitHub Check: build
GitHub Check: code

🔇 Additional comments (4)

packages/nuxt/src/core/templates.ts (4)

193-197: Proper module augmentation pattern implemented.

The changes introduce user-specific type aliases and implement proper module augmentation for @nuxt/schema. The pattern of extending interfaces with user-defined types allows for better type safety and separation of concerns between user-provided and generated types.

198-198: Well-structured module declaration split.

The module declaration for 'nuxt/schema' is now properly separated from the @nuxt/schema augmentation, creating a clear distinction between the two module contexts whilst maintaining the generated types within the appropriate namespace.

218-218: Consistent type usage for Vue component properties.

The change from RuntimeConfig to UserRuntimeConfig maintains consistency with the new user-specific type approach, ensuring that Vue components receive the correctly typed runtime configuration.

366-366: Reference directive correctly updated.

The reference path is properly updated to match the actual filename generated by the schemaTemplate ('types/runtime-config.d.ts'), ensuring TypeScript can correctly resolve the type definitions.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate Unit Tests

Create PR with Unit Tests
Post Copyable Unit Tests in Comment
Commit Unit Tests in branch fix/server-runtime-config

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-06-26T12:59:41Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 6509d83

codspeed-hq · 2025-06-26T13:11:16Z

CodSpeed Performance Report

Merging #32482 will not alter performance

_{Comparing fix/server-runtime-config (6509d83) with main (67cf2bf)}

Summary

✅ 10 untouched benchmarks

fix(nuxt): augment runtime config in server context

6509d83

github-actions bot added 4.x bug labels Jun 26, 2025

danielroe merged commit c032d35 into main Jun 26, 2025
82 of 84 checks passed

danielroe deleted the fix/server-runtime-config branch June 26, 2025 13:43

github-actions bot mentioned this pull request Jun 26, 2025

v4.0.0 #27716

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): augment runtime config in server context #32482

fix(nuxt): augment runtime config in server context #32482

Uh oh!

danielroe commented Jun 26, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jun 26, 2025

Uh oh!

coderabbitai bot commented Jun 26, 2025

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 Jun 26, 2025

Uh oh!

codspeed-hq bot commented Jun 26, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

fix(nuxt): augment runtime config in server context #32482

fix(nuxt): augment runtime config in server context #32482

Uh oh!

Conversation

danielroe commented Jun 26, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jun 26, 2025

Uh oh!

coderabbitai bot commented Jun 26, 2025

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 Jun 26, 2025

Uh oh!

codspeed-hq bot commented Jun 26, 2025

CodSpeed Performance Report

Merging #32482 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

CodeRabbit Configuration File (`.coderabbit.yaml`)