docs: document pluginOptionsSchema #27337
Merged
+30
−4
Conversation
This file contains 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
mxstbr
added
the
status: needs docs review
gatsbot
bot
added
the
status: triage needed
LekoArts
added
type: documentation
meganesu
suggested changes
Oct 14, 2020
| } | ||
| ``` | ||
|
|
||
| This ensures users pass a boolean to `optionA` and `optionB`, and a string to `message`. It also defaults the `message` option to "default message" in case users do not pass their own. |
There was a problem hiding this comment.
What happens when the validation fails? Is that something a user has to fix or the plugin author?
There was a problem hiding this comment.
The user has to adapt their configuration of the plugin! For example, if the error is "optionA is required", then the user would have to add optionA: true/false to it 👍
|
Updated based on the excellent suggestions @meganesu! How does this sound to you? |
meganesu
previously approved these changes
Oct 15, 2020
Co-authored-by: Megan Sullivan <megan@gatsbyjs.com>
mxstbr
added
bot: merge on green
5 tasks
This was referenced Apr 15, 2024
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 improves the documentation for the new
pluginOptionsSchemaNode API (introduced in #27166 and #27242) and adds a section about it to the existing "Configuring Plugin Usage with Plugin Options" doc.[ch15947]