feat: enhance api.transform typing with conditional types#6499
Merged
chenjiahan merged 1 commit intomainfrom Nov 4, 2025
Merged
feat: enhance api.transform typing with conditional types#6499chenjiahan merged 1 commit intomainfrom
api.transform typing with conditional types#6499chenjiahan merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds type-safe support for the raw option in transform hooks, ensuring that when raw: true is specified in a transform descriptor, the handler receives a Buffer instead of a string for the code property.
Key changes:
- Made
TransformContextandTransformHandlergeneric with aRawtype parameter - Updated
TransformHookto infer therawproperty from the descriptor and provide correct typing to the handler - Updated the transformer storage to accommodate handlers with different
rawconfigurations
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/core/src/types/plugin.ts | Added generic type parameters to TransformContext, TransformHandler, and TransformHook to support type-safe raw Buffer handling |
| packages/core/src/initPlugins.ts | Updated transformer record type to accept handlers with either raw or string code types |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Previously, the
codeproperty ofapi.transformwas always typed asstring | Buffer, requiring type checking even when the raw mode was known at compile time:This PR implemented conditional typing that provides precise types based on the
rawoption:Related Links
close #6017
Checklist