8000 fix(schema): override `vueCompilerOptions.plugins` type by danielroe · Pull Request #30454 · nuxt/nuxt · GitHub
[go: up one dir, main page]
Skip to content

fix(schema): override vueCompilerOptions.plugins type #30454

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 4, 2025
Merged

fix(schema): override vueCompilerOptions.plugins type #30454

merged 2 commits into from
Jan 4, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #30432

📚 Description

this overrides the one non-serialisable item in the vue compiler options of tsconfig

@danielroe danielroe self-assigned this Jan 4, 2025
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jan 4, 2025 •
edited
Loading

Warning

Rate limit exceeded

@danielroe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 55 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 24331cb and 61f8e7c.

📒 Files selected for processing (1)
  • packages/schema/src/config/typescript.ts (1 hunks)

Walkthrough

The pull request introduces modifications to TypeScript configuration type definitions across two files: packages/schema/src/config/typescript.ts and packages/schema/src/types/hooks.ts. The changes focus on refining the type annotation for vueCompilerOptions, specifically targeting the plugins property.

The primary modification involves using the Omit utility type to exclude the original plugins property from VueCompilerOptions while simultaneously introducing an optional plugins array. This approach provides enhanced type flexibility by allowing developers to specify plugin configurations with more granular control. The changes maintain the existing TypeScript configuration structure while offering a more precise type definition for Vue compiler options.

The modifications are consistent across both files, ensuring type compatibility and improving the schema's type safety for TypeScript and Vue compiler configurations.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Jan 4, 2025
View reviewed changes
Copy link
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/schema/src/config/typescript.ts (1)

76-76: Consider adding comments describing the type augmentation.

While this updated type signature effectively omits plugins and allows a string array for the vueCompilerOptions.plugins, consider adding a short comment to clarify the reasoning behind overriding plugins in this manner. This helps future maintainers quickly discern why these changes were applied.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b3ddc31 and 24331cb.

📒 Files selected for processing (2)
  • packages/schema/src/config/typescript.ts (1 hunks)
  • packages/schema/src/types/hooks.ts (1 hunks)
🔇 Additional comments (1)
packages/schema/src/types/hooks.ts (1)

26-26: Well-defined approach to customising Vue compiler plugins.

This update neatly enforces a serialisable array of plugin names, preventing direct non-serialisable references from appearing in vueCompilerOptions.plugins. This is a sound enhancement for maintainability and portability.

@danielroe danielroe merged commit 4afa905 into main Jan 4, 2025
44 checks passed
@danielroe danielroe deleted the fix/schema-vue-plugins branch January 4, 2025 22:30
@github-actions github-actions bot mentioned this pull request Jan 4, 2025
Merged
danielroe added a commit that referenced this pull request Jan 4, 2025
@danielroe
fix(schema): override vueCompilerOptions.plugins type (#30454)
a603d49
@github-actions github-actions bot mentioned this pull request Jan 4, 2025
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@danielroe @Kamsou
fix(schema): override vueCompilerOptions.plugins type (nuxt#30454)
1f9a9b0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

@danielroe danielroe

Labels
3.x bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Incorrect vueCompilerOptions.plugins in tsconfig when generated from nuxt.config
1 participant
@danielroe
0