make gatsby-plugin-image optional

gatsbyjs · Dec 11, 2020 · 93aa12a · 93aa12a
1 parent 7352949
commit 93aa12a
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 20 deletions.
diff --git a/packages/gatsby-source-contentful/package.json b/packages/gatsby-source-contentful/package.json
@@ -18,7 +18,6 @@
     "contentful": "^7.14.12",
     "fs-extra": "^9.0.1",
     "gatsby-core-utils": "^1.6.0-next.0",
-    "gatsby-plugin-image": "^0.2.0-next.0",
     "gatsby-plugin-utils": "^0.5.0-next.0",
     "gatsby-source-filesystem": "^2.7.0-next.2",
     "is-online": "^8.5.1",
@@ -43,6 +42,7 @@
   "license": "MIT",
   "peerDependencies": {
     "gatsby": "^2.12.1",
+    "gatsby-plugin-image": "^0.3.0-next.0",
     "gatsby-plugin-sharp": "^2.6.14"
   },
   "repository": {

diff --git a/packages/gatsby-source-contentful/src/extend-node-type.js b/packages/gatsby-source-contentful/src/extend-node-type.js
@@ -1,8 +1,6 @@
 const fs = require(`fs`)
 const path = require(`path`)
 const crypto = require(`crypto`)
-const { generateImageData } = require(`gatsby-plugin-image`)
-const { getGatsbyImageFieldConfig } = require(`gatsby-plugin-image/graphql`)
 
 const Promise = require(`bluebird`)
 const {
@@ -152,6 +150,7 @@ const fitMap = new Map([
 ])
 
 const resolveGatsbyImageData = async (image, options) => {
+  const { generateImageData } = require(`gatsby-plugin-image`)
   const { baseUrl, ...sourceMetadata } = getBasicImageProps(image, options)
 
   return generateImageData({
@@ -649,30 +648,46 @@ exports.extendNodeType = ({ type, store, cache, getNodesByType }) => {
 
   const fluidNode = fluidNodeType({ name: `ContentfulFluid`, getTracedSVG })
   const sizesNode = fluidNodeType({ name: `ContentfulSizes`, getTracedSVG })
-  const gatsbyImageData = getGatsbyImageFieldConfig(resolveGatsbyImageData, {
-    jpegProgressive: {
-      type: GraphQLBoolean,
-      defaultValue: true,
-    },
-    resizingBehavior: {
-      type: ImageResizingBehavior,
-    },
-    cropFocus: {
-      type: ImageCropFocusType,
-    },
-    quality: {
-      type: GraphQLInt,
-      defaultValue: 50,
-    },
-  })
   sizesNode.deprecationReason = `Sizes was deprecated in Gatsby v2. It's been renamed to "fluid" https://example.com/write-docs-and-fix-this-example-link`
 
+  // gatsby-pugin-image
+  const getGatsbyImageData = () => {
+    // @todo check if gatsby-plugin-image is enabled
+    const gatsbyImageEnabled = false
+    if (!gatsbyImageEnabled) {
+      return {
+        type: GraphQLString,
+        deprecated: true,
+        deprecationReason: `Enable gatsby-plugin-image to use this field.`,
+        resolve: () => null,
+      }
+    }
+    const { getGatsbyImageFieldConfig } = require(`gatsby-plugin-image/graphql`)
+
+    return getGatsbyImageFieldConfig(resolveGatsbyImageData, {
+      jpegProgressive: {
+        type: GraphQLBoolean,
+        defaultValue: true,
+      },
+      resizingBehavior: {
+        type: ImageResizingBehavior,
+      },
+      cropFocus: {
+        type: ImageCropFocusType,
+      },
+      quality: {
+        type: GraphQLInt,
+        defaultValue: 50,
+      },
+    })
+  }
+
   return {
     fixed: fixedNode,
     resolutions: resolutionsNode,
     fluid: fluidNode,
     sizes: sizesNode,
-    gatsbyImageData,
+    gatsbyImageData: getGatsbyImageData(),
     resize: {
       type: new GraphQLObjectType({
         name: `ContentfulResize`,