Добавьте 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, чтобы увидеть путь к файлу, не указывая его.

Однако, когда я пробую вышеописанное, я получаю следующую ошибку:

Поле \ "hero \" не должно иметь выбор, так как тип \ "String \" не имеет подполей.

Есть ли способ заставить childImageSharp распознать это поле?

Answer 1

Я снова вернулся (надеюсь), чтобы решить эту проблему раз и навсегда (см. Нашу историю здесь ).

На этот раз мы прикрепим изображение героя 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, но вы можете использовать regex для передачи списка разрешенных расширений, например, /hero.(png|jpg|gif|svg)/.(Я думаю, что ваше решение более читабельно, но я предпочитаю обращаться к файловой системе только один раз для каждого узла.)

Вы также можете использовать path.relative, чтобы найти относительный путь по умолчаниюизображение героя.

Теперь этот запрос GraphQL работает:

---

A (Незначительный) Задача

Однако с этим подходом есть небольшая проблема: он нарушает тип фильтра graphql!Когда я пытаюсь выполнить запрос и фильтрацию на основе hero, я получаю эту ошибку:

Возможно, Гэтсби забыл сделать вывод типа hero, так что вместо File это все равно String.Это раздражает, если вам нужен фильтр для работы.

Вот обходной путь: вместо того, чтобы просить Гэтсби связать файл, мы сделаем это сами.

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 обрабатывать тип узла.

Дайте мне знать, если вы столкнетесь с проблемами, пытаясь это сделать.