gatsby-plugin-csv-feed

    4.0.1 • Public • Published

    gatsby-plugin-csv-feed

    Current npm package version

    Gatsby plugin for creating CSV feeds. Can be used for creating dynamic Google Data Feeds, Facebook Catalog Feeds, Page Feeds, and feeds for other integrations. Uses json2csv to generate CSVs.

    Installing

    npm install --save gatsby-plugin-csv-feed

    Usage

    Here's an example of how to create a Custom Google Data Feed:

    // In your gatsby-config.js
    module.exports = {
      plugins: [
        {
          resolve: 'gatsby-plugin-csv-feed',
          options: {
            // Query to pass to all feed serializers (optional)
            query: `
              {
                site {
                  siteMetadata {
                    siteUrl
                  }
                }
              }
            `,
            // Options to pass to `json2csv` parser for all feeds (optional)
            parserOptions: {},
            // Feeds
            feeds: [
              {
                // Individual feed query
                query: `
                  {
                    allMarkdownRemark {
                      edges {
                        node {
                          frontmatter {
                            id
                            title
                            description
                            category
                            keywords
                            price
                            image
                          }
                          fields {
                            slug
                          }
                        }
                      }
                    }
                  }
                `,
                serialize: ({ query: { site, allMarkdownRemark } }) => {
                  return allMarkdownRemark.edges.map(edge => {
                    const node = Object.assign({}, edge.node.frontmatter, edge.node.fields);
                    return {
                      'ID': node.id,
                      'Item title': node.title,
                      'Item description': node.description,
                      'Image URL': `${site.siteMetadata.siteUrl}${node.image}`,
                      'Price': `${Number(node.price).toLocaleString('en-US')} USD`,
                      'Item Category': node.category,
                      'Contextual keywords': node.keywords.join(';'),
                      'Final URL': `${site.siteMetadata.siteUrl}${node.slug}`,
                    };
                  });
                },
                // Output file
                output: '/product-feed.csv',
                // Options to pass to `json2csv` parser for this feed (optional)
                parserOptions: {},
              },
            ],
          },
        },
      ]
    }

    Passing parser options to json2csv

    Additional options may be passed to json2csv via the parserOptions field. Pass parserOptions to all feeds by adding it to the plugin options object or to an individual feed by adding it to the feed object. Feed parserOptions take precedence over plugin parserOptions.

    To see a list of available options, view the JavaScript Module section of the json2csv package.

    License

    MIT © Hutson Inc

    Install

    npm i gatsby-plugin-csv-feed

    DownloadsWeekly Downloads

    189

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    13.7 kB

    Total Files

    7

    Last publish

    Collaborators

    • austinleegordon