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

Co-authored-by: gatsbybot <[email protected]>
Co-authored-by: LekoArts <[email protected]>

Author: 3 people

packages/gatsby-plugin-sitemap/src/__tests__/options-validation.js

@@ -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({})
 

packages/gatsby-plugin-sitemap/src/options-validation.js

@@ -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(