docs: enhance direct composition instructions and examples in README#8
Merged
Merged
Conversation
gr2m
approved these changes
Jul 1, 2026
|
🎉 This PR is included in version 1.0.0-beta.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
This pull request updates the documentation to clarify how to handle plugin configuration when using direct composition with the library. It adds a detailed example for wrappers that need to inspect and enforce required plugins before passing them to the core, and clarifies the authoritative source of plugins in direct composition scenarios.
Documentation improvements for direct composition:
README.mdto clarify thatconfigOptions.buildPlugins: falseis useful when wrapper code needs to read and enforce required plugins before passing them explicitly to the core.README.mddemonstrating how a wrapper can useresolveConfig(..., { buildPlugins: false })to read configured plugins, apply policy (such as ensuring required plugins), and then pass the final plugin list to the core.pluginsargument is always the authoritative source, regardless of whether it is constructed by the caller or a wrapper, and thatoptions.pluginsis not used as a fallback oncepluginsis provided.