// and we try not to use "ERROR" level at all.  module.exports = {-  plugins: ['jest'],+  plugins: ['jest', 'jest-dom', 'testing-library'],   overrides: [     {       files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],       env: {         'jest/globals': true,       },       // A subset of the recommended rules:-      // https://github.com/jest-community/eslint-plugin-jest#rules       rules: {-        'jest/expect-expect': 'warn',-        'jest/no-identical-title': 'warn',-        'jest/valid-describe': 'warn',-        'jest/valid-expect': 'warn',-        'jest/valid-expect-in-promise': 'warn',+        // https://github.com/jest-community/eslint-plugin-jest+        'jest/expect-expect': 'off',+        'jest/no-commented-out-tests': 'warn',+        'jest/no-conditional-expect': 'error',+        'jest/no-deprecated-functions': 'warn',+        'jest/no-disabled-tests': 'warn',+        'jest/no-done-callback': 'error',+        'jest/no-export': 'error',+        'jest/no-focused-tests': 'warn',+        'jest/no-identical-title': 'error',+        'jest/no-interpolation-in-snapshots': 'error',+        'jest/no-jasmine-globals': 'error',+        'jest/no-jest-import': 'error',+        'jest/no-mocks-import': 'error',+        'jest/no-standalone-expect': 'off',+        'jest/no-test-callback': 'off',+        'jest/no-test-prefixes': 'warn',+        'jest/valid-describe': 'error',+        'jest/valid-expect': 'error',+        'jest/valid-expect-in-promise': 'error',+        'jest/valid-title': 'warn',++        // https://github.com/testing-library/eslint-plugin-jest-dom+        'jest-dom/prefer-checked': 'warn',+        'jest-dom/prefer-empty': 'warn',+        'jest-dom/prefer-enabled-disabled': 'warn',+        'jest-dom/prefer-focus': 'warn',+        'jest-dom/prefer-required': 'warn',+        'jest-dom/prefer-to-have-attribute': 'warn',+        'jest-dom/prefer-to-have-style': 'warn',+        'jest-dom/prefer-to-have-text-content': 'warn',++        // https://github.com/testing-library/eslint-plugin-testing-library+        'testing-library/await-async-query': 'error',+        'testing-library/await-async-utils': 'error',+        'testing-library/no-await-sync-query': 'warn',+        'testing-library/no-debug': 'warn',+        'testing-library/no-dom-import': ['error', 'react'],+        'testing-library/no-manual-cleanup': 'error',+        'testing-library/no-render-in-setup': 'error',+        'testing-library/no-wait-for-empty-callback': 'error',+        'testing-library/no-wait-for-snapshot': 'error',+        'testing-library/prefer-explicit-assert': 'warn',+        'testing-library/prefer-find-by': 'warn',+        'testing-library/prefer-presence-queries': 'warn',+        'testing-library/prefer-screen-queries': 'warn',+        'testing-library/prefer-wait-for': 'warn',

 // and we try not to use "ERROR" level at all.  module.exports = {-  plugins: ['jest'],+  plugins: ['jest', 'jest-dom', 'testing-library'],   overrides: [     {       files: ['**/__tests__/**/*', '**/*.{spec,test}.*'],       env: {         'jest/globals': true,       },       // A subset of the recommended rules:-      // https://github.com/jest-community/eslint-plugin-jest#rules       rules: {-        'jest/expect-expect': 'warn',-        'jest/no-identical-title': 'warn',-        'jest/valid-describe': 'warn',-        'jest/valid-expect': 'warn',-        'jest/valid-expect-in-promise': 'warn',+        // https://github.com/jest-community/eslint-plugin-jest+        'jest/expect-expect': 'off',+        'jest/no-commented-out-tests': 'warn',+        'jest/no-conditional-expect': 'error',+        'jest/no-deprecated-functions': 'warn',+        'jest/no-disabled-tests': 'warn',+        'jest/no-done-callback': 'error',+        'jest/no-export': 'error',+        'jest/no-focused-tests': 'warn',+        'jest/no-identical-title': 'error',+        'jest/no-interpolation-in-snapshots': 'error',+        'jest/no-jasmine-globals': 'error',+        'jest/no-jest-import': 'error',+        'jest/no-mocks-import': 'error',+        'jest/no-standalone-expect': 'off',+        'jest/no-test-callback': 'off',+        'jest/no-test-prefixes': 'warn',+        'jest/valid-describe': 'error',+        'jest/valid-expect': 'error',+        'jest/valid-expect-in-promise': 'error',+        'jest/valid-title': 'warn',

+---+title: Validating plugin options+---++To help users [configure plugins](/docs/configuring-usage-with-plugin-options/) correctly, a plugin can optionally define a schema to enforce a type for each option. Gatsby will validate that the options users pass match the schema to help them correctly set up their site.++## How to define an options schema++To define their options schema, plugins export [`pluginOptionsSchema`](/docs/node-apis/#pluginOptionsSchema) from their `gatsby-node.js` file. This function gets passed an instance of [Joi](https://joi.dev) to define the schema with.++For example, consider the following plugin called `gatsby-plugin-console-log`:++```javascript:title=gatsby-config.js+module.exports = {+  plugins: [+    {+      resolve: `gatsby-plugin-console-log`,+      options: {+        optionA: true,+        message: "Hello world"+        optionB: false, // Optional.+      },+    },+  ],+}+```++`gatsby-plugin-console-log` can ensure users have to pass a boolean to `optionA` and a string to `message`, as well as optionally pass a boolean to `optionB`, with this `pluginOptionsSchema`:++```javascript:title=plugins/gatsby-plugin-console-log/gatsby-node.js+exports.pluginOptionsSchema = ({ Joi }) => {+  return Joi.object({+    optionA: Joi.boolean().required().description(`Enables optionA.`),+    message: Joi.string()+      .required()+      .description(`The message logged to the console.`),+    optionB: Joi.boolean().description(`Enables optionB.`),+  })+}+```++If users pass options that do not match the schema, the validation will show an error when they run `gatsby develop` and prompt them to fix their configuration.++## Unit testing an options schema++To verify that a `pluginOptionsSchema` behaves as expected, unit test it with different configurations using the [`gatsby-plugin-utils` package](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-utils#testpluginoptionsschema).++1. Add the `gatsby-plugin-utils` package to your site:++   ```shell+   npm install gatsby-plugin-utils+   ```++2. Use the `testPluginOptionsSchema` function exported from the package in your test file. For example, with [Jest](https://jestjs.io):++   ```javascript:title=plugins/gatsby-plugin-console/__tests__/gatsby-node.js+   // This is an example using Jest (https://jestjs.io/)+   import { testPluginOptionsSchema } from "gatsby-plugin-utils"+   import { pluginOptionsSchema } from "../gatsby-node"++   describe(`pluginOptionsSchema`, () => {+     it(`should invalidate incorrect options`, () => {+       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(+         pluginOptionsSchema,+         options+       )++       expect(isValid).toBe(false)+       expect(errors).toEqual([+         `"optionA" is required`,+         `"message" must be a string`,+         `"optionB" must be a boolean`,+       ])+     })++     it(`should validate correct options`, () => {+       const options = {+         optionA: false,+         message: "string",+         optionB: true,+       }+       const { isValid, errors } = testPluginOptionsSchema(+         pluginOptionsSchema,+         options+       )++       expect(isValid).toBe(true)+       expect(errors).toEqual([])+     })+   })+   ```++## Best practices for option schemas++The [Joi API documentation](https://joi.dev/api/) is a great reference to use while working on a `pluginOptionsSchema` as it shows all the available types and methods.++Here are some specific Joi best practices for `pluginOptionsSchema`s:++- [Add descriptions](#add-descriptions)+- [Set default options](#set-default-options)+- [Validate external access](#validate-external-access) where necessary+- [Add custom error messages](#add-custom-error-messages) where useful+- [Deprecate options](#deprecating-options) in a major version release rather than removing them++### Add descriptions++Make sure that every option and field has a `.description()` explaining its purpose. This is helpful for documentation as users can look at the schema and understand all the options. There might also be tooling in the future that auto-generates plugin option documentation from the schema.++### Set default options

+---+title: Validating plugin options+---++To help users [configure plugins](/docs/configuring-usage-with-plugin-options/) correctly, a plugin can optionally define a schema to enforce a type for each option. Gatsby will validate that the options users pass match the schema to help them correctly set up their site.++## How to define an options schema++To define their options schema, plugins export [`pluginOptionsSchema`](/docs/node-apis/#pluginOptionsSchema) from their `gatsby-node.js` file. This function gets passed an instance of [Joi](https://joi.dev) to define the schema with.++For example, consider the following plugin called `gatsby-plugin-console-log`:++```javascript:title=gatsby-config.js+module.exports = {+  plugins: [+    {+      resolve: `gatsby-plugin-console-log`,+      options: {+        optionA: true,+        message: "Hello world"+        optionB: false, // Optional.+      },+    },+  ],+}+```++`gatsby-plugin-console-log` can ensure users have to pass a boolean to `optionA` and a string to `message`, as well as optionally pass a boolean to `optionB`, with this `pluginOptionsSchema`:++```javascript:title=plugins/gatsby-plugin-console-log/gatsby-node.js+exports.pluginOptionsSchema = ({ Joi }) => {+  return Joi.object({+    optionA: Joi.boolean().required().description(`Enables optionA.`),+    message: Joi.string()+      .required()+      .description(`The message logged to the console.`),+    optionB: Joi.boolean().description(`Enables optionB.`),+  })+}+```++If users pass options that do not match the schema, the validation will show an error when they run `gatsby develop` and prompt them to fix their configuration.++## Unit testing an options schema++To verify that a `pluginOptionsSchema` behaves as expected, unit test it with different configurations using the [`gatsby-plugin-utils` package](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-utils#testpluginoptionsschema).++1. Add the `gatsby-plugin-utils` package to your site:++   ```shell+   npm install gatsby-plugin-utils+   ```++2. Use the `testPluginOptionsSchema` function exported from the package in your test file. For example, with [Jest](https://jestjs.io):++   ```javascript:title=plugins/gatsby-plugin-console/__tests__/gatsby-node.js+   // This is an example using Jest (https://jestjs.io/)+   import { testPluginOptionsSchema } from "gatsby-plugin-utils"+   import { pluginOptionsSchema } from "../gatsby-node"++   describe(`pluginOptionsSchema`, () => {+     it(`should invalidate incorrect options`, () => {+       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(+         pluginOptionsSchema,+         options+       )++       expect(isValid).toBe(false)+       expect(errors).toEqual([+         `"optionA" is required`,+         `"message" must be a string`,+         `"optionB" must be a boolean`,+       ])+     })++     it(`should validate correct options`, () => {+       const options = {+         optionA: false,+         message: "string",+         optionB: true,+       }+       const { isValid, errors } = testPluginOptionsSchema(+         pluginOptionsSchema,+         options+       )++       expect(isValid).toBe(true)+       expect(errors).toEqual([])+     })+   })+   ```++## Best practices for option schemas++The [Joi API documentation](https://joi.dev/api/) is a great reference to use while working on a `pluginOptionsSchema` as it shows all the available types and methods.++Here are some specific Joi best practices for `pluginOptionsSchema`s:++- [Add descriptions](#add-descriptions)+- [Set default options](#set-default-options)+- [Validate external access](#validate-external-access) where necessary+- [Add custom error messages](#add-custom-error-messages) where useful+- [Deprecate options](#deprecating-options) in a major version release rather than removing them++### Add descriptions++Make sure that every option and field has a `.description()` explaining its purpose. This is helpful for documentation as users can look at the schema and understand all the options. There might also be tooling in the future that auto-generates plugin option documentation from the schema.++### Set default options++You can use the `.default()` method to set a default value for an option. For example with `gatsby-plugin-console-log`, you can have the `message` option default to `"default message"` in case a user does not pass their own `message`:++```javascript:title=plugins/gatsby-plugin-console-log/gatsby-node.js+exports.pluginOptionsSchema = ({ Joi }) => {+  return Joi.object({+    optionA: Joi.boolean().required().description(`Enables optionA.`),+    message: Joi.string()+      .default(`default message`) // highlight-line+      .description(`The message logged to the console.`),+    optionB: Joi.boolean().description(`Enables optionB.`),+  })+}+```++Accessing `pluginOptions.message` would then log `"default message"` in all plugin APIs if the user does not supply their own value:++```javascript:title=plugins/gatsby-plugin-console-log/gatsby-node.js+exports.onPreInit = (_, pluginOptions) => {+  console.log(+    `logging: "${pluginOptions.message}" to the console` // highlight-line+  )+}+```++### Validating external access++Some plugins (particularly source plugins) query external APIs. With the `.external()` method, you can asynchronously validate that the user has access to the API, providing a better experience if they pass invalid secrets.++For example, this is how the [Contentful source plugin](/plugins/gatsby-source-contentful/) ensures the user has access to the space they are trying to query:++```javascript:title=gatsby-source-contentful/gatsby-node.js+exports.pluginOptionsSchema = ({ Joi }) => {+  return Joi.object({+    accessToken: Joi.string().required(),+    spaceId: Joi.string().required(),+    // ...more options here...+  }).external(async pluginOptions => {+    try {+      await contentful+        .createClient({+          space: pluginOptions.spaceId,+          accessToken: pluginOptions.accessToken,+        })+        .getSpace()+    } catch (err) {

+---+title: Validating plugin options+---++To help users [configure plugins](/docs/configuring-usage-with-plugin-options/) correctly, a plugin can optionally define a schema to enforce a type for each option. Gatsby will validate that the options users pass match the schema to help them correctly set up their site.++## How to define an options schema++To define their options schema, plugins export [`pluginOptionsSchema`](/docs/node-apis/#pluginOptionsSchema) from their `gatsby-node.js` file. This function gets passed an instance of [Joi](https://joi.dev) to define the schema with.++For example, consider the following plugin called `gatsby-plugin-console-log`:++```javascript:title=gatsby-config.js+module.exports = {+  plugins: [+    {+      resolve: `gatsby-plugin-console-log`,+      options: {+        optionA: true,+        message: "Hello world"+        optionB: false, // Optional.+      },+    },+  ],+}+```++`gatsby-plugin-console-log` can ensure users have to pass a boolean to `optionA` and a string to `message`, as well as optionally pass a boolean to `optionB`, with this `pluginOptionsSchema`:++```javascript:title=plugins/gatsby-plugin-console-log/gatsby-node.js+exports.pluginOptionsSchema = ({ Joi }) => {+  return Joi.object({+    optionA: Joi.boolean().required().description(`Enables optionA.`),+    message: Joi.string()+      .required()+      .description(`The message logged to the console.`),+    optionB: Joi.boolean().description(`Enables optionB.`),+  })+}+```++If users pass options that do not match the schema, the validation will show an error when they run `gatsby develop` and prompt them to fix their configuration.++## Unit testing an options schema++To verify that a `pluginOptionsSchema` behaves as expected, unit test it with different configurations using the [`gatsby-plugin-utils` package](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-utils#testpluginoptionsschema).++1. Add the `gatsby-plugin-utils` package to your site:++   ```shell+   npm install gatsby-plugin-utils

   ],   "scripts": {     "build": "kcd-scripts build --out-dir .",-    "contributors:add": "all-contributors add",-    "contributors:generate": "all-contributors generate",     "lint": "kcd-scripts lint",     "validate": "kcd-scripts validate"   },   "dependencies": {-    "@babel/runtime": "^7.9.2"+    "@babel/runtime": "^7.12.1"   },   "devDependencies": {-    "all-contributors-cli": "^6.14.0",-    "kcd-scripts": "^5.6.1"+    "kcd-scripts": "^6.6.0"

 learn how: http://kcd.im/pull-request  - `gatsby-plugin-pinterest` version: - `node` version:-- `npm` (or `yarn`) version:+- `npm` version:

-exports.onPreInit = ({ reporter }, options) => {-  if (!options.trackingId) {-    reporter.warn(-      `The Google Analytics plugin requires a tracking ID. Did you mean to add it?`-    )-  }-}

-exports.onPreInit = ({ reporter }, options) => {-  if (!options.trackingId) {-    reporter.warn(-      `The Google Analytics plugin requires a tracking ID. Did you mean to add it?`-    )-  }-}