Address comments from review

Author: ascorbic

packages/gatsby-plugin-image/src/components/__tests__/hooks.ts

@@ -35,75 +35,79 @@ const fileNode = {
 }
 
 describe(`The image helper functions`, () => {
-  it(`getImage returns the same data if passed gatsbyImageData`, () => {
-    expect(getImage(imageData)).toEqual(imageData)
-  })
-
-  it(`getImage gets an image from a FileNode`, () => {
-    expect(getImage(fileNode)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
-  })
-
-  it(`getImage gets an image from an IGatsbyImageDataParent`, () => {
-    expect(getImage(dataParent)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
-  })
-
-  it(`getSrc gets src from am image data object`, () => {
-    expect(getSrc(imageData)).toEqual(`imagesrc.jpg`)
-  })
-
-  it(`getSrc gets src from a FileNode`, () => {
-    expect(getSrc(fileNode)).toEqual(`imagesrc.jpg`)
-  })
-
-  it(`getSrc gets src from an IGatsbyImageDataParent`, () => {
-    expect(getSrc(dataParent)).toEqual(`imagesrc.jpg`)
-  })
-
-  it(`getSrcSet gets srcSet from am image data object`, () => {
-    expect(getSrcSet(imageData)).toEqual(`imagesrcset.jpg 1x`)
-  })
-
-  it(`getSrcSet gets srcSet from a FileNode`, () => {
-    expect(getSrcSet(fileNode)).toEqual(`imagesrcset.jpg 1x`)
-  })
-
-  it(`getSrcSet gets srcSet from an IGatsbyImageDataParent`, () => {
-    expect(getSrcSet(dataParent)).toEqual(`imagesrcset.jpg 1x`)
-  })
-
-  it(`getImage returns undefined from an invalid object`, () => {
-    expect(getImage(node)).toBeUndefined()
-  })
-
-  it(`getSrc returns undefined from an invalid object`, () => {
-    expect(getSrc(node)).toBeUndefined()
-  })
-
-  it(`getSrcSet returns undefined from an invalid object`, () => {
-    expect(getSrcSet(node)).toBeUndefined()
-  })
-
-  it(`getImage returns undefined when passed undefined`, () => {
-    expect(getImage((undefined as any) as Node)).toBeUndefined()
-  })
-
-  it(`getSrc returns undefined when passed undefined`, () => {
-    expect(getSrc((undefined as any) as Node)).toBeUndefined()
-  })
-
-  it(`getSrcSet returns undefined when passed undefined`, () => {
-    expect(getSrcSet((undefined as any) as Node)).toBeUndefined()
-  })
-
-  it(`getImage returns undefined when passed a number`, () => {
-    expect(getImage((1 as any) as Node)).toBeUndefined()
-  })
-
-  it(`getSrc returns undefined when passed a number`, () => {
-    expect(getSrc((1 as any) as Node)).toBeUndefined()
-  })
-
-  it(`getSrcSet returns undefined when passed a number`, () => {
-    expect(getSrcSet((1 as any) as Node)).toBeUndefined()
+  describe(`getImage`, () => {
+    it(`returns the same data if passed gatsbyImageData`, () => {
+      expect(getImage(imageData)).toEqual(imageData)
+    })
+
+    it(`gets an image from a FileNode`, () => {
+      expect(getImage(fileNode)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
+    })
+
+    it(`gets an image from an IGatsbyImageDataParent`, () => {
+      expect(getImage(dataParent)?.images.fallback?.src).toEqual(`imagesrc.jpg`)
+    })
+    it(`returns undefined from an invalid object`, () => {
+      expect(getImage(node)).toBeUndefined()
+    })
+
+    it(`returns undefined when passed a number`, () => {
+      expect(getImage((1 as any) as Node)).toBeUndefined()
+    })
+
+    it(`returns undefined when passed undefined`, () => {
+      expect(getImage((undefined as any) as Node)).toBeUndefined()
+    })
+  })
+
+  describe(`getSrc`, () => {
+    it(`gets src from an image data object`, () => {
+      expect(getSrc(imageData)).toEqual(`imagesrc.jpg`)
+    })
+
+    it(`gets src from a FileNode`, () => {
+      expect(getSrc(fileNode)).toEqual(`imagesrc.jpg`)
+    })
+
+    it(`gets src from an IGatsbyImageDataParent`, () => {
+      expect(getSrc(dataParent)).toEqual(`imagesrc.jpg`)
+    })
+
+    it(`returns undefined from an invalid object`, () => {
+      expect(getSrc(node)).toBeUndefined()
+    })
+    it(`returns undefined when passed undefined`, () => {
+      expect(getSrc((undefined as any) as Node)).toBeUndefined()
+    })
+
+    it(`returns undefined when passed a number`, () => {
+      expect(getSrc((1 as any) as Node)).toBeUndefined()
+    })
+  })
+
+  describe(`getSrcSet`, () => {
+    it(`gets srcSet from am image data object`, () => {
+      expect(getSrcSet(imageData)).toEqual(`imagesrcset.jpg 1x`)
+    })
+
+    it(`gets srcSet from a FileNode`, () => {
+      expect(getSrcSet(fileNode)).toEqual(`imagesrcset.jpg 1x`)
+    })
+
+    it(`gets srcSet from an IGatsbyImageDataParent`, () => {
+      expect(getSrcSet(dataParent)).toEqual(`imagesrcset.jpg 1x`)
+    })
+
+    it(`returns undefined from an invalid object`, () => {
+      expect(getSrcSet(node)).toBeUndefined()
+    })
+
+    it(`returns undefined when passed undefined`, () => {
+      expect(getSrcSet((undefined as any) as Node)).toBeUndefined()
+    })
+
+    it(`returns undefined when passed a number`, () => {
+      expect(getSrcSet((1 as any) as Node)).toBeUndefined()
+    })
   })
 })

packages/gatsby-plugin-image/src/components/hooks.ts

@@ -45,11 +45,15 @@ export type FileNode = Node & {
   childImageSharp?: IGatsbyImageDataParent<Node>
 }
 
-export const isGatsbyImageData = (
+const isGatsbyImageData = (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   node: IGatsbyImageData | any
-): node is IGatsbyImageData => Boolean(node?.images?.fallback?.src) // 🦆
+): node is IGatsbyImageData =>
+  // 🦆 check for a deep prop to be sure this is a valid gatsbyImageData object
+  Boolean(node?.images?.fallback?.src)
 
-export const isGatsbyImageDataParent = <T>(
+const isGatsbyImageDataParent = <T>(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   node: IGatsbyImageDataParent<T> | any
 ): node is IGatsbyImageDataParent<T> => Boolean(node?.gatsbyImageData)