refactor(nuxt): move references addition to `nitro:prepare:types` hook #33286

KazariEX · 2025-09-21T18:01:53Z

🔗 Linked issue

📚 Description

Just for consistency. Further changes are required after #33287.

bolt-new-by-stackblitz · 2025-09-21T18:01:56Z

Run & review this pull request in StackBlitz Codeflow.

pkg-pr-new · 2025-09-21T18:05:37Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 24c59ef

codspeed-hq · 2025-09-21T18:16:37Z

CodSpeed Performance Report

Merging #33286 will not alter performance

_{Comparing KazariEX:refactor/nitro-types-references (24c59ef) with main (73627c9)¹}

Summary

✅ 10 untouched

No successful run was found on main (c791676) during the generation of this report, so 73627c9 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

danielroe · 2025-09-23T09:53:22Z

merged #33287.

(you're on fire 🔥)

…s-references

coderabbitai · 2025-09-23T09:57:47Z

Walkthrough

Added a nitro:prepare:types hook in packages/nuxt/src/core/nuxt.ts to push ./app.config.d.ts and ./runtime-config.d.ts into Nitro’s type references.
The same hook logic appears twice in nuxt.ts, each pushing the same two references.
Removed two triple-slash reference pragmas (./app.config.d.ts and ./runtime-config.d.ts) from the Nitro schema template output in packages/nuxt/src/core/templates.ts.
No changes to exported or public entity signatures.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

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 (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly and accurately describes the primary change — moving the addition of type references into the nitro:prepare:types hook for Nuxt — and matches the PR objectives and file-level summaries.
Description Check	✅ Passed	The description is brief but related to the changeset, stating the intent (consistency) and noting follow-up work after #33287, so it is not off-topic.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

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: 0

🧹 Nitpick comments (1)

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

272-277: Guard against duplicate references in nitro:prepare:types.

If other hooks/modules add the same paths, duplicates may accumulate. Add a small guard.

-  // Add nitro types
-  nuxt.hook('nitro:prepare:types', (opts) => {
-    opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/app.config.d.ts') })
-    opts.references.push({ path: resolve(nuxt.options.buildDir, 'types/runtime-config.d.ts') })
-  })
+  // Add nitro types
+  nuxt.hook('nitro:prepare:types', (opts) => {
+    const addRef = (rel: string) => {
+      const p = resolve(nuxt.options.buildDir, rel)
+      if (!opts.references.some(r => 'path' in r && r.path === p)) {
+        opts.references.push({ path: p })
+      }
+    }
+    addRef('types/app.config.d.ts')
+    addRef('types/runtime-config.d.ts')
+  })

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 73627c9 and 24c59ef.

📒 Files selected for processing (2)

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

💤 Files with no reviewable changes (1)

packages/nuxt/src/core/templates.ts

🧰 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/nuxt.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). (3)

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

danielroe

🙏

refactor(nuxt): move references addition to nitro:prepare:types hook

d816e3b

KazariEX requested a review from danielroe as a code owner September 21, 2025 18:01

github-actions bot added 4.x refactor labels Sep 21, 2025

Merge remote-tracking branch 'upstream/main' into refactor/nitro-type…

24c59ef

…s-references

coderabbitai bot reviewed Sep 23, 2025

View reviewed changes

danielroe approved these changes Sep 23, 2025

View reviewed changes

danielroe merged commit a57f7fb into nuxt:main Sep 23, 2025
81 of 84 checks passed

KazariEX deleted the refactor/nitro-types-references branch September 23, 2025 11:32

github-actions bot mentioned this pull request Sep 23, 2025

v4.1.3 #33235

Merged

coderabbitai bot mentioned this pull request Jan 9, 2026

refactor(nitro,nuxt,schema): use augments for nitro schema types #34039

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor(nuxt): move references addition to `nitro:prepare:types` hook #33286

refactor(nuxt): move references addition to `nitro:prepare:types` hook #33286

Uh oh!

KazariEX commented Sep 21, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Sep 21, 2025

Uh oh!

pkg-pr-new bot commented Sep 21, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Sep 21, 2025 •

edited

Loading

Uh oh!

danielroe commented Sep 23, 2025

Uh oh!

coderabbitai bot commented Sep 23, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

danielroe left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor(nuxt): move references addition to nitro:prepare:types hook #33286

refactor(nuxt): move references addition to nitro:prepare:types hook #33286

Uh oh!

Conversation

KazariEX commented Sep 21, 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 Sep 21, 2025

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

CodSpeed Performance Report

Merging #33286 will not alter performance

Summary

Footnotes

Uh oh!

danielroe commented Sep 23, 2025

Uh oh!

coderabbitai bot commented Sep 23, 2025

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!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refactor(nuxt): move references addition to `nitro:prepare:types` hook #33286

refactor(nuxt): move references addition to `nitro:prepare:types` hook #33286

KazariEX commented Sep 21, 2025 •

edited

Loading

pkg-pr-new bot commented Sep 21, 2025 •

edited

Loading

codspeed-hq bot commented Sep 21, 2025 •

edited

Loading