Skip to content

fix(kit): include user-defined types before internal ones when generating tsconfig.json #31882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 24, 2025

Conversation

DamianGlowala
Copy link
Member

🔗 Linked issue

resolves #20379

📚 Description

This prioritises user-defined types over nuxt.d.ts (and others) and removes redundant .config/nuxt.* entry which is already included in **/*.

@DamianGlowala DamianGlowala self-assigned this Apr 23, 2025
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

coderabbitai bot commented Apr 23, 2025

Walkthrough

The changes reorder the initialization sequence of the include set within the _generateTypes function in the template.ts file, placing the pattern matching all files (**/*) first, followed by the .config/nuxt.* pattern, and finally './nuxt.d.ts'. A new TypeScript declaration file is added in the test fixtures, which augments the nuxt/schema module by introducing a PublicRuntimeConfig interface containing an ids property limited to an array of the numeric literals 1, 2, or 3. Corresponding test type assertions are updated to reflect this more specific type, changing the expected type of runtimeConfig.public.ids from a generic number[] to (1 | 2 | 3)[] in multiple test locations. No other logic or exported public entity declarations are modified.


📜 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 65199e7 and a96f23f.

📒 Files selected for processing (1)
  • packages/kit/src/template.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/kit/src/template.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: code
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: build

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.
    • 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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copy link

pkg-pr-new bot commented Apr 23, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: a96f23f

Copy link

codspeed-hq bot commented Apr 23, 2025

CodSpeed Performance Report

Merging #31882 will not alter performance

Comparing fix/typing-runtime-config (a96f23f) with main (4a77184)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit 712cd6c into main Apr 24, 2025
84 of 86 checks passed
@danielroe danielroe deleted the fix/typing-runtime-config branch April 24, 2025 13:06
@github-actions github-actions bot mentioned this pull request Apr 24, 2025
@github-actions github-actions bot mentioned this pull request Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manually set types for runtimeConfig are overwritten by the inferred types in nuxt.config
2 participants
pFad - Phonifier reborn

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

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy