docs(plugin): update apply property for its function signature#5654
Merged
chenjiahan merged 1 commit intomainfrom Jul 23, 2025
Merged
docs(plugin): update apply property for its function signature#5654chenjiahan merged 1 commit intomainfrom
apply property for its function signature#5654chenjiahan merged 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the apply property in Rsbuild plugins to include its function signature option. The documentation now properly explains that apply can be either a string value ('serve' | 'build') or a function that receives configuration and context parameters.
- Updates the type definition to include
Functionas an option for theapplyproperty - Adds comprehensive documentation explaining the function signature with TypeScript types
- Provides practical examples showing how to use the function form of
apply - Improves existing property descriptions with cross-references to detailed sections
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/plugins/dev/core.mdx | Updates Chinese documentation with function signature details and examples for the apply property |
| website/docs/en/plugins/dev/core.mdx | Updates English documentation with function signature details and examples for the apply property |
| packages/core/src/types/plugin.ts | Improves JSDoc comment for better consistency with documentation |
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Update the documentation of
applyproperty for its function signature.Related Links
Checklist