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

时间:2019-02-11 18:11:14

标签: graphql gatsby

我要尝试使用以下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中的图像路径进行了类似的操作,但是我不想在很容易获得graphql来查看文件路径而不必使用frontmatter的情况下指定它。

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

  

字段\“ hero \”不能选择,因为类型\“ String \”没有   子字段。

有没有办法让我childImageSharp来识别此字段?

1 个答案:

答案 0 :(得分:2)

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

这一次,我们将英雄图像的ImageSharp附加到MarkdownRemark节点。您的方法正确,有1个警告:盖茨比似乎只能识别相对路径,即以点开头的路径。

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

    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),
    })

这应该可行,尽管我想提供另一种英雄搜索功能。我们可以使用dir来获取fs.readdir中的文件列表,然后找到名称为“ 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查询有效:

enter image description here


一个(轻微)问题

但是,这种方法存在一个小问题:它破坏了graphql过滤器类型!当我尝试基于hero进行查询和过滤时,出现此错误:

enter image description here

也许盖茨比忘了重新推断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字段: enter image description here

如果您不需要按英雄图像过滤内容,则最好让gatsby处理节点类型。

让我知道您是否在尝试此操作时遇到问题。