Skip to content

fix(gatsby-plugin-sitemap): Add plugin options forbidden for deprecated exclude #32509

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
LekoArts merged 4 commits into from
Aug 4, 2021
Merged

fix(gatsby-plugin-sitemap): Add plugin options forbidden for deprecated exclude #32509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa27b52
Adds support for better error messaging when updating gatsby-plugin-s…
orta Jul 26, 2021
c6e8e14
Merge remote-tracking branch 'upstream/master' into sitemap-old-config
Aug 4, 2021
983b701
revert previous changes
LekoArts Aug 4, 2021
93c90d6
add plugin options forbidden
LekoArts Aug 4, 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
12 changes: 12 additions & 0 deletions packages/gatsby-plugin-sitemap/src/__tests__/options-validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ describe(`pluginOptionsSchema`, () => {
expect(errors).toEqual(expectedErrors)
})

it(`should provide error for deprecated "exclude" option`, async () => {
const expectedErrors = [
`As of v4 the \`exclude\` option was renamed to \`excludes\``,
]

const { errors } = await testPluginOptionsSchema(pluginOptionsSchema, {
exclude: [`test`],
})

expect(errors).toEqual(expectedErrors)
})

it(`creates correct defaults`, async () => {
const pluginOptions = await pluginOptionsSchema({ Joi }).validateAsync({})

Expand Down
3 changes: 3 additions & 0 deletions packages/gatsby-plugin-sitemap/src/options-validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@ export const pluginOptionsSchema = ({ Joi }) =>
enter other data types into this array for custom filtering.
Doing so will require customization of the \`filterPages\` function.`
),
exclude: Joi.forbidden().messages({
"any.unknown": `As of v4 the \`exclude\` option was renamed to \`excludes\``,
}),
resolveSiteUrl: Joi.function()
.default(() => resolveSiteUrl)
.description(
Expand Down