连接两个gatsby节点

时间:2019-01-15 16:52:24

标签: javascript graphql gatsby graphql-js

因此,我正在使用gatsby-mdx插件从MDX文件创建站点。我想在SitePage对象和Mdx对象之间创建关联,以便可以对SitePage边缘执行一个graphQL查询,以构建站点导航。

我的大部分代码都在TypeScript中,所以如果您想知道那些类型的WTF,请忽略任何类型注释。

我尝试过的事情

使用字段

我的第一个想法是使用onCreateNode API,获取MDX节点,然后使用createNodeField操作将其添加到SitePage中。一切都很好,以后使用adds a bunch of other info to their node API(在onCreateNode API之后 )对gatsby-mdx插件setFieldsOnGraphQLNodeType进行B-U-T处理。我希望这些字段(例如frontmatter和tableOfContents)在以后的graphql查询中可用,但它们没有使用此方法。

实施我自己的setFieldsOnGraphQLNodeType

我认为我可以像gatsby-mdx扩展Mdx节点一样扩展SitePage对象。

我在这里遇到的关键问题是我不知道如何创建Mdx GraphQL节点类型。

export const setFieldsOnGraphQLNodeType = ({type, actions, getNodes}: any, pluginOptions: any) => {
    if (type.name === "SitePage") {
        const {createParentChildLink} = actions
        return new Promise((resolve) => {
            return resolve({
                "childMdx": {
                    type: new GraphQLObjectType({
                        name: 'Mdx'
                    }),
                    async resolve(sitePageNode: any) {
                        const allNodes = getNodes()
                        if (sitePageNode.component &&
                            (sitePageNode.component.endsWith(".mdx") || sitePageNode.component === DefaultLayout)
                        ) {
                            const associatedMdx = allNodes.find((mdxNode: any) =>
                                mdxNode.internal.type === 'Mdx' && mdxNode.fileAbsolutePath === sitePageNode.component
                            )
                            if (associatedMdx) {
                                console.log("Found associated MDX node", associatedMdx.id)
                                console.log("Adding it to the sitepage node", sitePageNode.id)
                                return associatedMdx
                            }
                        }
                    }
                }
            })
        })
    }
    return {}
}

我还尝试过简单地将类型作为字符串('Mdx')传递,但这也失败了。

使用父子链接

该插件使用createParentChildLink操作(source)在onCreateNode API中的File节点和解析的MDX节点之间创建了父子链接。

我试图实现这一目标...

export const onCreateNode = ({node, actions, getNodes}: OnCreateNodeArgument) => {
    const {createParentChildLink} = actions
    const allNodes = getNodes()
    if (node.internal && node.internal.type === 'SitePage' && node.component &&
        (node.component.endsWith(".mdx") || node.component === DefaultLayout)
    ) {
        const associatedMdx = allNodes.find((mdxNode: any) =>
            mdxNode && mdxNode.internal && mdxNode.internal.type === 'Mdx' &&
                (mdxNode.fileAbsolutePath === node.component || mdxNode.fileAbsolutePath === node.context.fileAbsolutePath)
        )
        if (associatedMdx) {
            console.log("Found associated MDX node", associatedMdx.id)
            console.log("Adding it to the sitepage node as a child", node.id)
            createParentChildLink({parent: node, child: associatedMdx})
        }
    }
}

乍看起来似乎成功了,但是gatsby-mdx添加到Mdx节点的tableOfContents property在诸如以下的graphQL查询中仍然不可用:

{
    allSitePage(filter: {fields: {childMdx: {id: {ne: null}}}}) {
        edges {
            node {
                path
                fields{
                    childMdx {
                        tableOfContents
                        fileAbsolutePath
                        frontmatter {
                            title
                        }
                    }
                }
                context {
                    roughFilePath
                    id
                }
            }
        }
    }
}

其他(可能不相关)信息

我是gatsby-node.js中的creating some pages programmatically

我已经看到使用node type mappings的类似用例的建议,但是由于我在SitePage和MDX对象之间的映射需要一些技巧(特别是,从siteMetadata读取一些内容并执行一个字符串)比较),我认为这不适用于我的用例。

1 个答案:

答案 0 :(得分:3)

因此,我终于找到了一个更好的解决方案(比我以前的尝试,后者涉及将mdx节点注入页面的context中)。

盖茨比有一个undocumented method可以将节点彼此链接:

  

是的,您可以将createNodeField与尚未记录的___NODE语法一起使用,以在节点之间创建链接。

因此,步骤如下:

  • createPage中,将Mdx节点的id存储到SitePage节点。
  • onCreateNode中,如果节点为SitePage,请使用createNodeField,将Mdx___NODE作为字段名称,并将Mdx节点的ID作为值。

我的gatsby-node.js

const path = require("path")
const { createFilePath } = require("gatsby-source-filesystem")

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

  if (node.internal.type === "SitePage" && node.context && node.context.id) {

    createNodeField({
      name: "Mdx___NODE",
      value: node.context.id,
      node,
    })
  }

  if (node.internal.type === "Mdx") {
    const value = createFilePath({ node, getNode })
    createNodeField({
      // 1) this is the name of the field you are adding,
      name: "slug",
      // 2) this node refers to each individual MDX
      node,
      value: `/blog${value}`
    })
  }
}


exports.createPages = async ({ graphql, actions }) => {
  const { createPage } = actions;
  const { data, errors } = await graphql(`
    {
      allMdx {
        edges {
          node {
            id
            fields {
              slug
            }
          }
        }
      }
    }
  `)

  if (errors) throw errors
  data.allMdx.edges.forEach(({ node }) => {
    createPage({
      path: node.fields.slug,
      component: path.resolve(`./src/components/posts-page-layout.js`),
      context: { id: node.id }
    });
  });
};

结果:

graphiql

希望有帮助!