graphql - 将 ImageSharp 作为字段添加到 MarkdownRemark 节点(不是 frontmatter)

Question

我正在尝试使用以下 graphQL 查询:

 {
      allMarkdownRemark(
        limit: 1000
      ) {
        edges {
          node {
            id
            parent {
              id
            }
            fields{
              slug
              hero {
                childImageSharp {
                  fixed {
                    src
                  }
                }
              }
            }
            frontmatter {
              template
            }
          }
        }
      }
    }

hero 字段当前使用以下代码返回图像的路径:

exports.onCreateNode = ({ node, actions, getNode }) => {
  const { createNodeField } = actions

  // Add slug to MarkdownRemark node
  if (node.internal.type === 'MarkdownRemark') {
    const value = createFilePath({ node, getNode, basePath: 'library' })
    const { dir } = getNode(node.parent)
    const getHero = (d) => {
      let hero = `${__dirname}/src/images/no-hero.gif`
      if (fs.existsSync(`${d}/hero.jpg`)) hero = `${d}/hero.jpg`
      if (fs.existsSync(`${d}/hero.png`)) hero = `${d}/hero.png`
      if (fs.existsSync(`${d}/hero.gif`)) hero = `${d}/hero.gif`
      return hero
    }
    createNodeField({
      node,
      name: 'slug',
      value,
    })

    createNodeField({
      node,
      name: 'hero',
      value: getHero(dir),
    })
  }
}

我看到其他人对 frontmatter 中的图像路径做了类似的事情，但我不想使用 frontmatter，因为它很容易让 graphql 查看文件路径而不必指定它。

但是，当我尝试上述操作时，出现以下错误:

Field \"hero\" must not have a selection since type \"String\" has no subfields.

有没有办法让 childImageSharp 识别这个字段？

Answer 1

我再次回来(希望)一劳永逸地解决这个问题(请参阅我们的历史 here)。

这一次，我们将把主图的 ImageSharp 附加到 MarkdownRemark 节点。您的方法正确，但有 1 个警告:Gatsby 似乎只识别相对路径，即以点开头的路径。

您可以在代码中轻松解决此问题:

    const getHero = (d) => {
      let hero = `${__dirname}/src/images/no-hero.gif`

  -   if (fs.existsSync(`${d}/hero.jpg`)) hero = `${d}/hero.jpg`
  -   if (fs.existsSync(`${d}/hero.png`)) hero = `${d}/hero.png`
  -   if (fs.existsSync(`${d}/hero.gif`)) hero = `${d}/hero.gif`

  +   if (fs.existsSync(`${d}/hero.jpg`)) hero = `./hero.jpg`
  +   if (fs.existsSync(`${d}/hero.png`)) hero = `./hero.png`
  +   if (fs.existsSync(`${d}/hero.gif`)) hero = `./hero.gif`

      return hero
    }
    createNodeField({
      node,
      name: 'hero',
      value: getHero(dir),
    })

虽然我想提供一个替代的英雄搜索功能，但它应该可以工作。我们可以使用 fs.readdir 获取 dir 中的文件列表，然后找到名为“hero”的文件:

exports.onCreateNode = async ({
  node, actions,
}) => {
  const { createNodeField } = actions

  if (node.internal.type === 'MarkdownRemark') {
    const { dir } = path.parse(node.fileAbsolutePath)

    const heroImage = await new Promise((res, rej) => {

      // get a list of files in `dir`
      fs.readdir(dir, (err, files) => {
        if (err) rej(err)

        // if there's a file named `hero`, return it
        res(files.find(file => file.includes('hero')))
      })
    })

    // path.relative will return a (surprise!) a relative path from arg 1 to arg 2.
    // you can use this to set up your default hero
    const heroPath = heroImage 
      ? `./${heroImage}` 
      : path.relative(dir, 'src/images/default-hero.jpg')

    // create a node with relative path
    createNodeField({
      node,
      name: 'hero',
      value: `./${heroImage}`,
    })
  }
}

这样我们就不用关心主图的扩展名是什么，只要它存在即可。我使用 String.prototype.includes，但为了安全起见，您可能希望使用正则表达式传递允许的扩展名列表，例如 /hero.(png|jpg|gif|svg )/。 (我认为您的解决方案更具可读性，但我更喜欢每个节点只访问一次文件系统。)

您还可以使用 path.relative找到默认主图的相对路径。

现在，这个 graphql 查询有效了:

---

一个(小)问题

但是，这种方法有一个小问题:它破坏了 graphql 过滤器类型!当我尝试基于 hero 进行查询和过滤时，我得到了这个错误:

也许 Gatsby 忘记了重新推断 hero 的类型，所以它不是 File，而是 String。如果您需要过滤器工作，这会很烦人。

这里有一个解决方法:我们将自己完成，而不是要求 Gatsby 链接文件。

exports.onCreateNode = async ({
  node, actions, getNode, getNodesByType,
}) => {
  const { createNodeField } = actions

  // Add slug to MarkdownRemark node
  if (node.internal.type === 'MarkdownRemark') {
    const { dir } = path.parse(node.fileAbsolutePath)
    const heroImage = await new Promise((res, rej) => {
      fs.readdir(dir, (err, files) => {
        if (err) rej(err)
        res(files.find(file => file.includes('hero')))
      })
    })

    // substitute with a default image if there's no hero image
    const heroPath = heroImage ? path.join(dir, heroImage) : path.resolve(__dirname, 'src/images/default-hero.jpg')

    // get all file nodes
    const fileNodes = getNodesByType('File')

    // find the hero image's node
    const heroNode = fileNodes.find(fileNode => fileNode.absolutePath === heroPath)
    createNodeField({
      node,
      name: 'hero___NODE',
      value: heroNode.id,
    })
  }
}

现在我们可以再次过滤 hero 字段:

如果您不需要通过英雄图片过滤内容，让 gatsby 处理节点类型会更可取。

如果您在尝试此操作时遇到问题，请告诉我。