Gatsby-plugin-utils NPM | npm.io

4.13.1 • Published 3 months ago

Install

Weekly downloads

369,011

License

MIT

Repository

Last release

3 months ago

gatsby-plugin-utils

Usage

npm install gatsby-plugin-utils

`validateOptionsSchema`

The validateOptionsSchema function verifies that the proper data types of options were passed into a plugin from the gatsby-config.js file. It is called internally by Gatsby to validate each plugin's options when a site is started.

Example

import { validateOptionsSchema } from "gatsby-plugin-utils"

await validateOptionsSchema(pluginName, pluginSchema, pluginOptions)

`testPluginOptionsSchema`

Utility to validate and test plugin options schemas. An example of a plugin options schema implementation can be found in the gatsby-node.js file of gatsby-plugin-google-analytics.

Example

// This is an example using Jest (https://jestjs.io/)
import { testPluginOptionsSchema } from "gatsby-plugin-utils"

it(`should partially validate one value of a schema`, async () => {
  const pluginSchema = ({ Joi }) =>
    Joi.object({
      someOtherValue: Joi.string(),
      toVerify: Joi.boolean(),
    })
  const expectedErrors = [`"toVerify" must be a boolean`]

  // Only the "toVerify" key of the schema will be verified in this test
  const { isValid, errors } = await testPluginOptionsSchema(pluginSchema, {
    toVerify: `abcd`,
  })

  expect(isValid).toBe(false)
  expect(errors).toEqual(expectedErrors)
})

`isGatsbyNodeLifecycleSupported`

Utility to be used by plugins to do runtime check against gatsby core package checking wether particular gatsby-node lifecycle API is supported. Useful for plugins to be able to support multiple gatsby core versions.

Example

const { isGatsbyNodeLifecycleSupported } = require(`gatsby-plugin-utils`)

// only use createSchemaCustomization lifecycle only when it's available.
if (isGatsbyNodeLifecycleSupported(`createSchemaCustomization`)) {
  exports.createSchemaCustomization = function createSchemaCustomization({
    actions,
  }) {
    // customize schema
  }
}

`hasFeature`

Feature detection is now part of Gatsby. As a plugin author you don't know what version of Gatsby a user is using. hasFeature allows you to check if the current version of Gatsby has a certain feature.

Here's a list of features: // TODO

Example

const { hasFeature } = require(`gatsby-plugin-utils`)

if (!hasFeature(`image-cdn`)) {
  // You can polyfill image-cdn here so older versions have support as well
}

Add ImageCDN support

Our new ImageCDN allows source plugins to lazily download and process images. if you're a plugin author please use this polyfill to add support for all Gatsby V4 versions.

For more information (see here)https://gatsby.dev/img

Example

const {
  addRemoteFilePolyfillInterface,
  polyfillImageServiceDevRoutes,
} = require(`gatsby-plugin-utils/pollyfill-remote-file`)

exports.createSchemaCustomization ({ actions, schema, store }) => {
  actions.createTypes([
    addRemoteFilePolyfillInterface(
      schema.buildObjectType({
        name: `PrefixAsset`,
        fields: {
          // your fields
        },
        interfaces: [`Node`, 'RemoteFile'],
      }),
      {
        schema,
        actions,
        store
      }
    )
  ]);
}

/** @type {import('gatsby').onCreateDevServer} */
exports.onCreateDevServer = ({ app, store }) => {
  polyfillImageServiceDevRoutes(app, store)
}

@babel/runtime fastq fs-extra gatsby-core-utils gatsby-sharp graphql-compose import-from joi mime

gatsby-source-optimizely-v2 gatsby-source-contentful gatsby-plugin-mdx gatsby-plugin-sharp gatsby @everything-registry/sub-chunk-1722 @ascorbic/gatsby @ascorbic/gatsby-plugin-sharp @abcagency/gatsby-source-airtable-next @smithc/gatsby-source-contentful @throttleup/gatsby @throttleup/gatsby-source-wordpress @zalastax/nolb-gatsby-plugin-u @aurorafossorg/gatsby-plugin-feed-reproducible @redocly/gatsby-plugin-manifest @valschr/gatsby-source-shopify @wbrauneis/gatsby-plugin-vcf @cosmicjs/gatsby-source-cosmic @geocine/gatsby-plugin-feed @dotdev/gatsby-source-sanity @jpfulton/gatsby-plugin-feed-mdx @jeff-tian/gatsby-plugin-sharp gatsby-plugin-page-creator gatsby-plugin-pdf-export gatsby-plugin-noodl gatsby-source-shopify gatsby-source-wordpress gatsby-plugin-prismic-previews gatsby-transformer-sharp @luisinimagigi/gatsby-transformer-cloudinary gatsby-plugin-sharp-test gatsby-source-drupal gatsby-source-datocms gatsby-source-directus9 gatsby-plugin-json gatsby-plugin-kameleoon gatsby-plugin-image gatsby-plugin-feed gatsby-plugin-feed-mdx gatsby-plugin-fastify gatsby-plugin-fastify-klyngen gatsby-plugin-manifest gatsby-source-airtable-next gatsby-source-prismic gatsby-source-sanity gatsby-source-sanity-exo gatsby-source-sanity-light gatsby-transformer-cloudinary @ninetailed/experience.js-gatsby @raae/gatsby-source-youtube-oembed

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

5 months ago

6 months ago

6 months ago

4.13.0-alpha-alt-image-cdn.44

6 months ago

6 months ago

8 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

9 months ago

10 months ago

1 year ago

4.9.0-image-cdn-configurable.4

1 year ago

1 year ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

4.0.0-alpha-v5.d20221010t183635.51

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

4.0.0-alpha-v5.d20221007t081809.41

2 years ago

1 year ago

1 year ago

3.8.0-alpha-transformer-json.26

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

1 year ago

4.0.0-alpha-v5.d20221012t101120.57

2 years ago

1 year ago

1 year ago

1 year ago

3.19.0-alpha-image-cdn-pathprefix.47

2 years ago

3.19.0-alpha-image-cdn-pathprefix.48

2 years ago

1 year ago

1 year ago

4.0.0-alpha-drupal-proxyurl.14

1 year ago

4.0.0-alpha-v5.d20221005t111511.35

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

3.18.1-alpha-wordpress-image-err.26

1 year ago

3.18.1-alpha-wordpress-image-err.27

1 year ago

3.18.1-alpha-wordpress-image-err.25

1 year ago

1 year ago

4.0.0-alpha-v5.26

2 years ago

4.0.0-alpha-v5.25

2 years ago

4.0.0-alpha-v5.24

2 years ago

2 years ago

3.17.0-alpha-v5.26

2 years ago

4.0.0-alpha-v5.16

2 years ago

2 years ago

3.17.0-alpha-preview-gh-api.26

2 years ago

3.17.0-alpha-a5-peer.70

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.17.0-alpha-9689ff.25

2 years ago

2 years ago

2 years ago

3.17.0-alpha-image-cdn-enc.23

2 years ago

3.17.0-alpha-image-cdn-enc.40

2 years ago

2 years ago

2 years ago

2 years ago

3.11.0-alpha-drupal-image-404.12

2 years ago

2 years ago

2 years ago

3.12.0-alpha-image-cdn-jobs-resolve.32

2 years ago

3.14.0-mdxv4-rc.65

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.12.0-mdxv4-rc.68

2 years ago

3.12.0-mdxv4-rc.76

2 years ago

2 years ago

3.12.0-alpha-mdx-v2.68

2 years ago

3.10.0-alpha-image-cdn-caching.9

2 years ago

3.14.0-mdxv4-rc.60

2 years ago

3.12.0-alpha-mdx-v2.66

2 years ago

3.12.0-alpha-drupal-self-reference.18

2 years ago

3.9.0-alpha-wp-image-cdn-auth.42

2 years ago

3.9.0-alpha-wp-image-cdn-auth.46

2 years ago

3.9.0-alpha-wp-image-cdn-auth.45

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.5.0-alpha-luda.30

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.7.0-alpha-image-cdn-telemetry.29

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.3.0-alpha-image-cdn.68

2 years ago

2 years ago

2 years ago

2 years ago

3.3.0-alpha-image-cdn.49

2 years ago

3.3.0-alpha-image-cdn.54

2 years ago

3.3.0-alpha-image-cdn.36

2 years ago

2 years ago

3.3.0-alpha-image-cdn.37

2 years ago

3.3.0-alpha-image-cdn.32

2 years ago

3.2.0-alpha-image-service.54

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.2.0-alpha-image-service.34

2 years ago

3.2.0-alpha-image-service.33

2 years ago

3.2.0-alpha-image-service.32

2 years ago

2 years ago

3.2.0-alpha-image-service.35

2 years ago

2 years ago

3.3.0-alpha-image-service2.14

2 years ago

2 years ago

3.0.0-alpha-ts-jit.26

2 years ago

2 years ago

2 years ago

3.1.0-alpha-image-service.13

2 years ago

3.1.0-alpha-image-service.15

2 years ago

3.1.0-alpha-image-service.14

2 years ago

3.1.0-alpha-image-service.16

2 years ago

2 years ago

2 years ago

3.2.0-alpha-image-service.29

2 years ago

3.2.0-alpha-image-service.28

2 years ago

2 years ago

3.2.0-alpha-image-service.27

2 years ago

3.2.0-alpha-image-service.26

2 years ago

3.2.0-alpha-image-service.25

2 years ago

3.2.0-alpha-image-service.24

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.0.0-zz-next.3

3 years ago

2.0.0-zz-next.2

3 years ago

3 years ago

2.0.0-zz-next.1

3 years ago

2.0.0-zz-next.8

3 years ago

1.14.0-alpha-qe-sm.46

3 years ago

3 years ago

3 years ago

2.0.0-alpha-9689ff.13

3 years ago

2.0.0-alpha-9689ff.34

3 years ago

2.0.0-alpha-9689ff.36

3 years ago

2.0.0-alpha-9689ff.22

3 years ago

2.0.0-alpha-9689ff.24

3 years ago

2.0.0-alpha-9689ff.17

3 years ago

2.0.0-alpha-9689ff.8

3 years ago

3 years ago

3 years ago

3 years ago

1.11.0-alpha-qe-sm.108

3 years ago

2.0.0-alpha-9689ff.5

3 years ago

3 years ago

1.11.0-alpha-qe-sm.83

3 years ago

1.11.0-alpha-qe-sm.86

3 years ago

1.11.0-alpha-qe-sm.85

3 years ago

3 years ago

2.0.0-alpha-9689ff.27

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

0.4.0-image-helpers.58

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

0.2.36-static-image.17092

3 years ago

3 years ago

3 years ago

3 years ago

0.2.37-dev-ssr-2.17009

3 years ago

4 years ago

0.2.29-dev-ssr-2.16931

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

0.2.31-query-modules-debug-missing-sq.23

4 years ago

4 years ago

4 years ago

4 years ago