README.md

gatsby-plugin-why-did-you-render-redux

Include the @welldone-software/why-did-you-render library when running gatsby develop. It includes support for tracing useSelector in your redux store.

Installation

Using npm:

npm i gatsby-plugin-why-did-you-render-redux

Using yarn:

yarn add gatsby-plugin-why-did-you-render-redux

How To Use

This plugin allows for most options available in @welldone-software/why-did-you-render. include, exclude, and notifier aren't able to pass from gatsby-config.js to the plugin because Gatsby stringifies all plugin options. As a result, you can pass in include and exclude arrays as strings which will be used to construct simple new RegExp(string) instances. notifier is completely unsupported.

An additional option is added called trackUseSelector, which specifically targets tracing redux selectors as it requires a special step to configure. This means you don't need to add useSelector to trackExtraHooks.

You can set it up in your Gatsby project by adding it to gatsby-config.js like this:

{
  // ...
  plugins: [
    {
      resolve: 'gatsby-plugin-why-did-you-render-redux',
      options: {
        trackAllPureComponents: true,
        trackUseSelector: true,
      },
    },
    // ...
  ],
  // ...
}

{
  // ...
  plugins: [
    {
      resolve: 'gatsby-plugin-why-did-you-render-redux',
      options: {
        include: ['MyComponent', 'MyOtherComponent']
      },
    },
    // ...
  ],
  // ...
}