Skip to content

Update plugin option schema validation code sample #28904

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

Merged
merged 2 commits into from
Jan 21, 2021
Merged

Update plugin option schema validation code sample #28904

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdfd53c
Update configuring-usage-with-plugin-options.md
Simply007 Jan 7, 2021
bd3f7d6
Add mention about Kontent implementation
Simply007 Jan 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/docs/how-to/plugins-and-themes/configuring-usage-with-plugin-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,13 +240,13 @@ import { testPluginOptionsSchema } from "gatsby-plugin-utils"
import { pluginOptionsSchema } from "../gatsby-node"

describe(`pluginOptionsSchema`, () => {
it(`should invalidate incorrect options`, () => {
it(`should invalidate incorrect options`, async () => {
const options = {
optionA: undefined, // Should be a boolean
message: 123, // Should be a string
optionB: `not a boolean`, // Should be a boolean
}
const { isValid, errors } = testPluginOptionsSchema(
const { isValid, errors } = await testPluginOptionsSchema(
pluginOptionsSchema,
options
)
Expand All @@ -259,13 +259,13 @@ describe(`pluginOptionsSchema`, () => {
])
})

it(`should validate correct options`, () => {
it(`should validate correct options`, async () => {
const options = {
optionA: false,
message: "string",
optionB: true,
}
const { isValid, errors } = testPluginOptionsSchema(
const { isValid, errors } = await testPluginOptionsSchema(
pluginOptionsSchema,
options
)
Expand All @@ -281,3 +281,4 @@ describe(`pluginOptionsSchema`, () => {
- [Example Gatsby site using plugin options with a local plugin](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-plugin-options)
- [Joi API documentation](https://joi.dev/api/)
- [`pluginOptionsSchema` for the Contentful source plugin](https://github.com/gatsbyjs/gatsby/blob/af973d4647dc14c85555a2ad8f1aff08028ee3b7/packages/gatsby-source-contentful/src/gatsby-node.js#L75-L159)
- [`pluginOptionsSchema` for the Kontent source plugin](https://github.com/Kentico/kontent-gatsby-packages/blob/master/packages/gatsby-source-kontent/src/pluginOptionsSchema.ts#L2-L35)