fix(nuxt): constrain global `defineAppConfig` type #32760

danielroe · 2025-07-25T11:49:26Z

🔗 Linked issue

resolves #32745

📚 Description

the global type for defineAppConfig 'leaked' (regression from #32528) and removed the constraint we imposed here:

Lines 564 to 566 in 85be4bd

    
           export function defineAppConfig<C extends AppConfigInput> (config: C): C { 
        
             return config 
        
           }

bolt-new-by-stackblitz · 2025-07-25T11:49:29Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-25T11:51:30Z

Walkthrough

The update refines the TypeScript declaration for the global function defineAppConfig in the Nuxt core templates. The function's generic parameter is now constrained to types extending AppConfigInput, rather than accepting any type. Additionally, the import statement is modified to include AppConfigInput from 'nuxt/schema' alongside CustomAppConfig. These changes ensure that any configuration passed to defineAppConfig must conform to the AppConfigInput type.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation is now available in beta!

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

📜 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 d8d2f3e and 553888f.

📒 Files selected for processing (1)

packages/nuxt/src/core/templates.ts (1 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/nuxt/src/core/templates.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). (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (2)

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

450-450: LGTM! Import statement correctly updated.

The addition of AppConfigInput to the import statement is necessary for the type constraint applied to defineAppConfig below.

455-455: Excellent fix! Type constraint properly restored.

The generic constraint <C extends AppConfigInput> successfully addresses the type leakage issue mentioned in the PR objectives. This ensures that defineAppConfig only accepts configuration objects that extend AppConfigInput, improving type safety whilst maintaining proper type inference.

✨ 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/typed-app-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 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-25T11:53:09Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 553888f

codspeed-hq · 2025-07-25T12:03:26Z

CodSpeed Performance Report

Merging #32760 will not alter performance

_{Comparing fix/typed-app-config (553888f) with main (d8d2f3e)}

Summary

✅ 10 untouched benchmarks

gklauda3 · 2025-07-29T21:08:46Z

Get this error since upgrading to Nuxt 4.0.2 (from 4.0.0). I guess this might be related:

danielroe · 2025-07-29T21:18:40Z

@gklauda3 would you open a new issue with a reproduction?

this pr would not cause the issue you report

gklauda3 · 2025-07-29T22:16:34Z

I'm so sorry for having wasted your time. Had nothing to do with the update. I had experimented with "autoImport: false" in a layer to find out how to conditionally load it. Had forgotten to remove the option after I was finished.

danielroe · 2025-07-29T22:18:20Z

no worries! glad you solved it

fix(nuxt): constrain global defineAppConfig type

553888f

danielroe self-assigned this Jul 25, 2025

danielroe added types bug labels Jul 25, 2025

github-actions bot added the 4.x label Jul 25, 2025

danielroe merged commit 8fafa66 into main Jul 25, 2025
84 of 85 checks passed

danielroe deleted the fix/typed-app-config branch July 25, 2025 13:14

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

v4.0.2 #32710

Merged

danielroe mentioned this pull request Jul 25, 2025

useAppConfig lose types from nuxt schema with new tsconfig #32768

Open

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): constrain global `defineAppConfig` type #32760

fix(nuxt): constrain global `defineAppConfig` type #32760

Uh oh!

danielroe commented Jul 25, 2025 •

edited

Loading

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 25, 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 Jul 25, 2025

Uh oh!

codspeed-hq bot commented Jul 25, 2025

Uh oh!

Uh oh!

gklauda3 commented Jul 29, 2025

Uh oh!

danielroe commented Jul 29, 2025

Uh oh!

gklauda3 commented Jul 29, 2025

Uh oh!

danielroe commented Jul 29, 2025

Uh oh!

Uh oh!

	export function defineAppConfig<C extends AppConfigInput> (config: C): C {
	return config
	}

Uh oh!

fix(nuxt): constrain global defineAppConfig type #32760

fix(nuxt): constrain global defineAppConfig type #32760

Uh oh!

Conversation

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

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

coderabbitai bot commented Jul 25, 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!

pkg-pr-new bot commented Jul 25, 2025

Uh oh!

codspeed-hq bot commented Jul 25, 2025

CodSpeed Performance Report

Merging #32760 will not alter performance

Summary

Uh oh!

Uh oh!

gklauda3 commented Jul 29, 2025

Uh oh!

danielroe commented Jul 29, 2025

Uh oh!

gklauda3 commented Jul 29, 2025

Uh oh!

danielroe commented Jul 29, 2025

Uh oh!

Uh oh!

fix(nuxt): constrain global `defineAppConfig` type #32760

fix(nuxt): constrain global `defineAppConfig` type #32760

danielroe commented Jul 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)