Plugin Options Validation

[mxstbr]

As of [email protected], plugins can define a schema to enforce a type for each of their options. Gatsby will validate that the options users pass match the schema to help them correctly set up their site.

To learn more, check out the "How to validate plugin options" documentation.

How you can help

We need you to please add pluginOptionsSchemas to your own Gatsby plugins! Once your plugin has a schema, Gatsby can guarantee users it is configured correctly.

If you're looking to contribute to Gatsby, we could also use your help converting the most popular plugins in our monorepo to have pluginOptionsSchemas.

If you would like to help us:

1. Select one of the unclaimed plugins below (check the comments first to see if anyone else has claimed it!)
2. Comment in this issue that you're claiming the plugin
3. Look at the documentation for the plugin to figure out which options exist
4. Write a pluginOptionsSchema in the plugins' gatsby-node.js file (if it doesn't have one, create it) following the best practices

Core plugins

• gatsby-plugin-canonical-urls
• gatsby-plugin-catch-links
• gatsby-plugin-create-client-paths
• gatsby-plugin-cxs
• gatsby-plugin-emotion
• gatsby-plugin-feed
• gatsby-plugin-glamor
• gatsby-plugin-google-analytics
• gatsby-plugin-google-gtag
• gatsby-plugin-google-tagmanager
• gatsby-plugin-image
• gatsby-plugin-layout
• gatsby-plugin-less
• gatsby-plugin-lodash
• gatsby-plugin-manifest
• gatsby-plugin-mdx
• gatsby-plugin-netlify
• gatsby-plugin-netlify-cms
• gatsby-plugin-nprogress
• gatsby-plugin-offline
• gatsby-plugin-page-creator
• gatsby-plugin-postcss
• gatsby-plugin-preact
• gatsby-plugin-react-helmet
• gatsby-plugin-remove-trailing-slashes
• gatsby-plugin-sass
• gatsby-plugin-sharp
• gatsby-plugin-sitemap
• gatsby-plugin-styled-components
• gatsby-plugin-styled-jsx
• gatsby-plugin-twitter
• gatsby-plugin-typescript
• gatsby-plugin-typography
• gatsby-remark-autolink-headers
• gatsby-remark-copy-linked-files
• gatsby-remark-images
• gatsby-remark-images-contentful
• gatsby-remark-prismjs
• gatsby-remark-responsive-iframe
• gatsby-remark-smartypants
• gatsby-source-contentful
• gatsby-source-drupal
• gatsby-source-filesystem
• gatsby-source-graphql
• gatsby-source-shopify
• gatsby-source-wordpress
• gatsby-transformer-json
• gatsby-transformer-remark
• gatsby-transformer-sharp
• gatsby-transformer-yaml