reese / gatsby-plugin-stork

A Gatsby plugin for generating Stork search indexes.

🌱🌱🌱

Hello! I'm Reese (he/him), a Software Engineer working on ✨Ruby things✨ at Stripe, and previously I worked at HubSpot and The Gnar Company.

gatsby-plugin-stork's Issues

Bug: Undefined errors while attempting to create new index

Hi Reese @reese ,

Thank you so much for creating this plugin! 👏 I was trying to use this in my Gatsby site, and was unfortunately running into few internal errors from the plugin.

This is my configuration for the gatsby plugin. I have ensured and validated from Gatsby's GraphQL explorer that the below fields exist correctly for nodes of type annotations:

    {
      resolve: "gatsby-plugin-stork",
      options: {
        indexes: [
          {
            resolvers: {
              annotations: {
                url: node => node.fields.book_slug_path,
                title: node => node.extracted_google_books_metadata.book_title,
                contents: node => node.extracted_google_books_metadata.book_description,
              }
            },
            filename: 'annotations.st'
          }
        ],
        theme: "dark",
      }
    }

And for some reason, i keep on running into this exception below - which seems related to this line:

 ERROR #11321  PLUGIN

"gatsby-plugin-stork" threw an error while running the onPostBootstrap lifecycle:

Cannot set property 'title' of undefined

  60 |                             var key = _ref6[0],
  61 |                                 resolveFunc = _ref6[1];
> 62 |                             acc[key] = resolveFunc(node);
     |                                      ^
  63 |                           }, {});
  64 |                           files.push(resolvedValues);
  65 |                         }); // Serialize and write to TOML

File: node_modules/gatsby-plugin-stork/gatsby-node.js:62:38



  TypeError: Cannot set property 'title' of undefined

I tried to oversimplify the config above to this subsequently, i.e, just hardcoded strings - and even then I'm running into the same exception as above. Surely if there was some issue with my nodes configuration above and if that might have been resulting in the exception above, then it should have succeeded here:

    {
      resolve: "gatsby-plugin-stork",
      options: {
        indexes: [
          {
            resolvers: {
              annotations: {
                url: node => "test1",
                title: node => "test2",
                contents: node => "test3",
              }
            },
            filename: 'annotations.st'
          }
        ],
        theme: "dark",
      }
    },

Would really appreciate if you could help with this? If you need any other blob of local nodes or other related configs from my end for looking into this, please let me know.

Thanks! :)

Support generating multiple search indexes.

Some users may want to generate multiple search indexes based on multiple queries or configurations, such as searching only on an individual page, search only through one subset of content, etc.

Create a Gatsby starter using this plugin.

Creating a gatsby starter with this plugin pre-installed should hopefully make this more approachable and allow more users to get the benefits of search by default.

implement `yarn start`

after brew install stork-search/stork-tap/stork 👇🏻

Support all JS configuration options on the input component.

stork.register has a lot of available options (see here) that should be supported as props in the React component.

Add option to delay `stork.register` until user interaction.

See jameslittle230/stork#102. This isn't currently supported in Stork itself but could be a good configuration options.

Feature Request: Add support for pathPrefix in the plugin

Building on #12 - When using pathPrefix, urls in the plugin config must be pre-process with gatsby's pathPrefix before sending to Stork. This will help achieve both seamless local develop testing as well as correct urls in search results for production builds.

Support all index configuration options

This plugin should support passing all available configuration options from here when generating the index file.

Add option to install Stork during CI builds.

Many users will deploy this using Github Actions, Netlify, or similar build providers. Installing Stork during CI builds by default (and allowing users to opt-out if needed) would save many users some headaches.