feat(nuxt): warn if user uses reserved `runtimeConfig.app` namespace #31774

danielroe · 2025-04-11T15:19:06Z

🔗 Linked issue

📚 Description

Nuxt uses an internal namespace in runtimeConfig which is exposed to the browser.

this PR warns + removes user configuration set here, and we also document that this is exposed to the client.

bolt-new-by-stackblitz · 2025-04-11T15:19:09Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-04-11T15:22:33Z

Walkthrough

The changes update the Nuxt documentation and core functionality. The documentation now states that both keys from runtimeConfig.public and runtimeConfig.app are available on the client side, rather than exclusively from runtimeConfig.public. Additionally, a validation mechanism has been introduced in the Nuxt core (within the loadNuxt function) to ensure that keys in options.runtimeConfig.app do not conflict with reserved namespaces. A set of allowed keys—namely baseURL, buildAssetsDir, cdnURL, and buildId—is used to verify the keys. If an unsupported key is detected, a warning is logged and the key is deleted from the configuration. No changes were made to the declarations of exported or public entities.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 376d8a4 and 36e0bba.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

packages/nuxt/src/core/nuxt.ts

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

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

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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 resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/2.guide/3.going-further/10.runtime-config.md (1)
95-95: Documentation clarified about client-side runtime config accessibility

This update correctly explains that both runtimeConfig.public and runtimeConfig.app (used internally by Nuxt) are available on the client-side.

Note: There's a minor grammar issue with "On client-side" - it should be "On the client-side" for consistency with the server-side statement on line 97.
-- On client-side, only keys in `runtimeConfig.public` and `runtimeConfig.app` (which is used by Nuxt internally) are available, and the object is both writable and reactive.
+- On the client-side, only keys in `runtimeConfig.public` and `runtimeConfig.app` (which is used by Nuxt internally) are available, and the object is both writable and reactive.
🧰 Tools

🪛 LanguageTool

[uncategorized] ~95-~95: You might be missing the article “the” here.
Context: ... the client-side and server-side: - On client-side, only keys in `runtimeConfig.publi...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b0b1bb6 and 376d8a4.

📒 Files selected for processing (3)

docs/1.getting-started/03.configuration.md (1 hunks)
docs/2.guide/3.going-further/10.runtime-config.md (1 hunks)
packages/nuxt/src/core/nuxt.ts (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/2.guide/3.going-further/10.runtime-config.md

[uncategorized] ~95-~95: You might be missing the article “the” here.
Context: ... the client-side and server-side: - On client-side, only keys in `runtimeConfig.publi...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

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

GitHub Check: test-fixtures (windows-latest, built, webpack, default, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, webpack, default, manifest-on, json, 18)
GitHub Check: test-fixtures (windows-latest, dev, vite, default, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-off, json, 18)
GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, rspack, default, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-off, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, built, rspack, async, manifest-on, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 18)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 18)
GitHub Check: typecheck (windows-latest, bundler)
GitHub Check: release-pr
GitHub Check: test-benchmark
GitHub Check: typecheck (ubuntu-latest, bundler)
GitHub Check: code

🔇 Additional comments (1)

docs/1.getting-started/03.configuration.md (1)

65-65: Clear documentation update about runtimeConfig.app visibility

This change accurately documents that both runtimeConfig.public and runtimeConfig.app namespaces are accessible client-side, which improves developer understanding of Nuxt's runtime configuration behavior.

packages/nuxt/src/core/nuxt.ts

pkg-pr-new · 2025-04-11T15:23:10Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 36e0bba

codspeed-hq · 2025-04-11T15:39:08Z

CodSpeed Performance Report

Merging #31774 will not alter performance

_{Comparing feat/warn-app (36e0bba) with main (8431235)}

Summary

✅ 10 untouched benchmarks

…31774)

danielroe added 2 commits April 11, 2025 16:16

feat(nuxt): warn if user uses reserved runtimeConfig.app namespace

02f8f21

docs: update docs

376d8a4

danielroe self-assigned this Apr 11, 2025

danielroe requested a review from atinux April 11, 2025 15:19

github-actions bot added 3.x enhancement labels Apr 11, 2025

coderabbitai bot reviewed Apr 11, 2025

View reviewed changes

packages/nuxt/src/core/nuxt.ts Outdated Show resolved Hide resolved

chore: whoops

36e0bba

atinux approved these changes Apr 11, 2025

View reviewed changes

danielroe merged commit 7bbeedf into main Apr 11, 2025
48 checks passed

danielroe deleted the feat/warn-app branch April 11, 2025 20:34

github-actions bot mentioned this pull request Apr 11, 2025

v4.0.0 #27716

Draft

danielroe added a commit that referenced this pull request Apr 14, 2025

feat(nuxt): warn if user uses reserved runtimeConfig.app namespace (#…

52739f4

…31774)

github-actions bot mentioned this pull request Apr 14, 2025

v3.17.0 #31687

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(nuxt): warn if user uses reserved `runtimeConfig.app` namespace #31774

feat(nuxt): warn if user uses reserved `runtimeConfig.app` namespace #31774

Uh oh!

danielroe commented Apr 11, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Apr 11, 2025

Uh oh!

coderabbitai bot commented Apr 11, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Apr 11, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Apr 11, 2025

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

feat(nuxt): warn if user uses reserved runtimeConfig.app namespace #31774

feat(nuxt): warn if user uses reserved runtimeConfig.app namespace #31774

Uh oh!

Conversation

danielroe commented Apr 11, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Apr 11, 2025

Uh oh!

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

Uh oh!

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

codspeed-hq bot commented Apr 11, 2025

CodSpeed Performance Report

Merging #31774 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

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

feat(nuxt): warn if user uses reserved `runtimeConfig.app` namespace #31774

feat(nuxt): warn if user uses reserved `runtimeConfig.app` namespace #31774

coderabbitai bot commented Apr 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Apr 11, 2025 •

edited

Loading