Document and slightly modify node APIs

gatsbyjs · KyleAMathews · May 31, 2017 · May 28, 2017 · May 29, 2017 · May 30, 2017
commit 3c77aa32562abea07e8b6b651d89af638d6d9fcb
diff --git a/docs/docs/migrating-from-v0-to-v1.md b/docs/docs/migrating-from-v0-to-v1.md
@@ -133,7 +133,7 @@ Here's how you do that.
 // In your gatsby-node.js
 const path = require('path')
 
-exports.onNodeCreate = ({ node, boundActionCreators, getNode }) => {
+exports.onCreateNode = ({ node, boundActionCreators, getNode }) => {
   const { createNodeField } = boundActionCreators
   let slug
   if (node.internal.type === `MarkdownRemark`) {

diff --git a/packages/gatsby-remark-copy-linked-files/src/index.js b/packages/gatsby-remark-copy-linked-files/src/index.js
@@ -8,7 +8,10 @@ module.exports = ({ files, markdownNode, markdownAST, getNode }) => {
   // Copy linked files to the public directory and modify the AST to point to
   // new location of the files.
   const visitor = link => {
-    if (isRelativeUrl(link.url)) {
+    if (
+      isRelativeUrl(link.url) &&
+      getNode(markdownNode.parent).internal.type === `File`
+    ) {
       const linkPath = path.join(getNode(markdownNode.parent).dir, link.url)
       const linkNode = _.find(files, file => {
         if (file && file.absolutePath) {

diff --git a/packages/gatsby-transformer-documentationjs/src/__tests__/__snapshots__/gatsby-node.js.snap b/packages/gatsby-transformer-documentationjs/src/__tests__/__snapshots__/gatsby-node.js.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`transformer-react-doc-gen: onNodeCreate should extract out a description, params, and examples 1`] = `
+exports[`transformer-react-doc-gen: onCreateNode should extract out a description, params, and examples 1`] = `
 Array [
   Object {
     "children": Array [],

diff --git a/packages/gatsby-transformer-documentationjs/src/__tests__/fixtures/code.js b/packages/gatsby-transformer-documentationjs/src/__tests__/fixtures/code.js
@@ -6,5 +6,5 @@
  * apple()
  */
 const apple = apple => {
-  console.log("hi")
+  console.log(`hi`)
 }
diff --git a/packages/gatsby-transformer-documentationjs/src/__tests__/gatsby-node.js b/packages/gatsby-transformer-documentationjs/src/__tests__/gatsby-node.js
@@ -2,10 +2,10 @@ import groupBy from "lodash/groupBy"
 import path from "path"
 import gatsbyNode from "../gatsby-node"
 
-describe(`transformer-react-doc-gen: onNodeCreate`, () => {
+describe(`transformer-react-doc-gen: onCreateNode`, () => {
   let boundActionCreators, node, createdNodes, updatedNodes
   let run = (node = node, opts = {}) =>
-    gatsbyNode.onNodeCreate(
+    gatsbyNode.onCreateNode(
       {
         node,
         boundActionCreators,

diff --git a/packages/gatsby-transformer-documentationjs/src/gatsby-node.js b/packages/gatsby-transformer-documentationjs/src/gatsby-node.js
@@ -1,8 +1,8 @@
-const documentation = require("documentation")
-const crypto = require("crypto")
+const documentation = require(`documentation`)
+const crypto = require(`crypto`)
 const digest = str => crypto.createHash(`md5`).update(str).digest(`hex`)
 const remark = require(`remark`)
-const _ = require("lodash")
+const _ = require(`lodash`)
 const Prism = require(`prismjs`)
 
 const stringifyMarkdownAST = (node = ``) => {
@@ -46,10 +46,10 @@ function createDescriptionNode(
 }
 
 /**
- * Implement the onNodeCreate API to create documentation.js nodes
+ * Implement the onCreateNode API to create documentation.js nodes
  * @param {Object} super this is a super param
  */
-exports.onNodeCreate = async ({
+exports.onCreateNode = async ({
   node,
   loadNodeContent,
   boundActionCreators,

diff --git a/packages/gatsby-transformer-json/src/__tests__/gatsby-node.js b/packages/gatsby-transformer-json/src/__tests__/gatsby-node.js
@@ -1,7 +1,7 @@
 const Promise = require(`bluebird`)
 const _ = require(`lodash`)
 
-const { onNodeCreate } = require(`../gatsby-node`)
+const { onCreateNode } = require(`../gatsby-node`)
 
 describe(`Process JSON nodes correctly`, () => {
   const node = {
@@ -29,7 +29,7 @@ describe(`Process JSON nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,
@@ -52,7 +52,7 @@ describe(`Process JSON nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,
@@ -74,7 +74,7 @@ describe(`Process JSON nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,

diff --git a/packages/gatsby-transformer-json/src/gatsby-node.js b/packages/gatsby-transformer-json/src/gatsby-node.js
@@ -3,7 +3,7 @@ const fs = require(`fs`)
 const _ = require(`lodash`)
 const crypto = require(`crypto`)
 
-async function onNodeCreate({ node, boundActionCreators, loadNodeContent }) {
+async function onCreateNode({ node, boundActionCreators, loadNodeContent }) {
   const { createNode, createParentChildLink } = boundActionCreators
 
   // Don't reprocess our own nodes!  (note: this doesn't normally happen
@@ -57,4 +57,4 @@ async function onNodeCreate({ node, boundActionCreators, loadNodeContent }) {
   return
 }
 
-exports.onNodeCreate = onNodeCreate
+exports.onCreateNode = onCreateNode
diff --git a/packages/gatsby-transformer-react-docgen/src/__tests__/on-node-create.js b/packages/gatsby-transformer-react-docgen/src/__tests__/on-node-create.js
@@ -1,7 +1,7 @@
 import fs from "fs"
 import path from "path"
 import { groupBy } from "lodash"
-import onNodeCreate from "../on-node-create"
+import onCreateNode from "../on-node-create"
 
 const readFile = file =>
   new Promise((y, n) => {
@@ -12,10 +12,10 @@ const readFile = file =>
     )
   })
 
-describe(`transformer-react-doc-gen: onNodeCreate`, () => {
+describe(`transformer-react-doc-gen: onCreateNode`, () => {
   let loadNodeContent, boundActionCreators, node, createdNodes, updatedNodes
   let run = (node, opts = {}) =>
-    onNodeCreate(
+    onCreateNode(
       {
         node,
         loadNodeContent,

diff --git a/packages/gatsby-transformer-react-docgen/src/gatsby-node.js b/packages/gatsby-transformer-react-docgen/src/gatsby-node.js
@@ -1,2 +1,2 @@
-exports.onNodeCreate = require(`./on-node-create`).default
-exports.extendNodeType = require(`./extend-node-type`).default
+exports.onCreateNode = require(`./on-node-create`).default
+exports.setFieldsOnGraphQLNodeType = require(`./extend-node-type`).default
diff --git a/packages/gatsby-transformer-react-docgen/src/on-node-create.js b/packages/gatsby-transformer-react-docgen/src/on-node-create.js
@@ -61,7 +61,7 @@ function createPropNodes(node, component, boundActionCreators) {
   return node
 }
 
-export default function onNodeCreate(
+export default function onCreateNode(
   { node, loadNodeContent, boundActionCreators },
   pluginOptions
 ) {

diff --git a/packages/gatsby-transformer-remark/src/__tests__/gatsby-node.js b/packages/gatsby-transformer-remark/src/__tests__/gatsby-node.js
@@ -1,6 +1,6 @@
 const Promise = require(`bluebird`)
 
-const { onNodeCreate } = require(`../gatsby-node`)
+const { onCreateNode } = require(`../gatsby-node`)
 
 describe(`Process markdown content correctly`, () => {
   const node = {
@@ -29,7 +29,7 @@ Where oh where is my little pony?
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,

diff --git a/packages/gatsby-transformer-remark/src/gatsby-node.js b/packages/gatsby-transformer-remark/src/gatsby-node.js
@@ -1,2 +1,2 @@
-exports.onNodeCreate = require(`./on-node-create`)
-exports.extendNodeType = require(`./extend-node-type`)
+exports.onCreateNode = require(`./on-node-create`)
+exports.setFieldsOnGraphQLNodeType = require(`./extend-node-type`)
diff --git a/packages/gatsby-transformer-remark/src/on-node-create.js b/packages/gatsby-transformer-remark/src/on-node-create.js
@@ -1,7 +1,7 @@
 const grayMatter = require(`gray-matter`)
 const crypto = require(`crypto`)
 
-module.exports = async function onNodeCreate({
+module.exports = async function onCreateNode({
   node,
   getNode,
   loadNodeContent,

diff --git a/packages/gatsby-transformer-sharp/src/__tests__/gatsby-node.js b/packages/gatsby-transformer-sharp/src/__tests__/gatsby-node.js
@@ -1,6 +1,6 @@
 const Promise = require(`bluebird`)
 
-const { onNodeCreate } = require(`../gatsby-node`)
+const { onCreateNode } = require(`../gatsby-node`)
 
 describe(`Process image nodes correctly`, () => {
   it(`correctly creates an ImageSharp node from a file image node`, async () => {
@@ -16,7 +16,7 @@ describe(`Process image nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       boundActionCreators,
     }).then(() => {

diff --git a/packages/gatsby-transformer-sharp/src/gatsby-node.js b/packages/gatsby-transformer-sharp/src/gatsby-node.js
@@ -1,2 +1,2 @@
-exports.onNodeCreate = require(`./on-node-create`)
-exports.extendNodeType = require(`./extend-node-type`)
+exports.onCreateNode = require(`./on-node-create`)
+exports.setFieldsOnGraphQLNodeType = require(`./extend-node-type`)
diff --git a/packages/gatsby-transformer-sharp/src/on-node-create.js b/packages/gatsby-transformer-sharp/src/on-node-create.js
@@ -1,6 +1,6 @@
 const _ = require(`lodash`)
 
-module.exports = async function onNodeCreate({ node, boundActionCreators }) {
+module.exports = async function onCreateNode({ node, boundActionCreators }) {
   const { createNode, createParentChildLink } = boundActionCreators
 
   const extensions = [`jpeg`, `jpg`, `png`, `webp`, `tif`, `tiff`, `svg`]

diff --git a/packages/gatsby-transformer-yaml/src/__tests__/gatsby-node.js b/packages/gatsby-transformer-yaml/src/__tests__/gatsby-node.js
@@ -2,7 +2,7 @@ const Promise = require(`bluebird`)
 const yaml = require(`js-yaml`)
 const _ = require(`lodash`)
 
-const { onNodeCreate } = require(`../gatsby-node`)
+const { onCreateNode } = require(`../gatsby-node`)
 
 describe(`Process YAML nodes correctly`, () => {
   const node = {
@@ -27,7 +27,7 @@ describe(`Process YAML nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,
@@ -50,7 +50,7 @@ describe(`Process YAML nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,
@@ -72,7 +72,7 @@ describe(`Process YAML nodes correctly`, () => {
     const createParentChildLink = jest.fn()
     const boundActionCreators = { createNode, createParentChildLink }
 
-    await onNodeCreate({
+    await onCreateNode({
       node,
       loadNodeContent,
       boundActionCreators,

diff --git a/packages/gatsby-transformer-yaml/src/gatsby-node.js b/packages/gatsby-transformer-yaml/src/gatsby-node.js
@@ -5,7 +5,7 @@ const jsYaml = require(`js-yaml`)
 const _ = require(`lodash`)
 const crypto = require(`crypto`)
 
-async function onNodeCreate({ node, boundActionCreators, loadNodeContent }) {
+async function onCreateNode({ node, boundActionCreators, loadNodeContent }) {
   const { createNode, createParentChildLink } = boundActionCreators
   if (node.internal.mediaType !== `text/yaml`) {
     return
@@ -49,4 +49,4 @@ async function onNodeCreate({ node, boundActionCreators, loadNodeContent }) {
   return
 }
 
-exports.onNodeCreate = onNodeCreate
+exports.onCreateNode = onCreateNode
diff --git a/packages/gatsby/src/bootstrap/index.js b/packages/gatsby/src/bootstrap/index.js
@@ -237,7 +237,7 @@ data
   // have full control over adding/removing pages. The normal
   // "createPages" API is called every time (during development)
   // that data changes.
-  await apiRunnerNode(`createPagesStateful`, {
+  await apiRunnerNode(`createPagesStatefully`, {
     graphql: graphqlRunner,
   })
 

diff --git a/packages/gatsby/src/bootstrap/internal-plugins/component-page-creator/gatsby-node.js b/packages/gatsby/src/bootstrap/internal-plugins/component-page-creator/gatsby-node.js
@@ -13,7 +13,7 @@ const createPath = require(`./create-path`)
 // algorithm is glob /pages directory for js/jsx/cjsx files *not*
 // underscored. Then create url w/ our path algorithm *unless* user
 // takes control of that page component in gatsby-node.
-exports.createPagesStateful = async ({ store, boundActionCreators }) => {
+exports.createPagesStatefully = async ({ store, boundActionCreators }) => {
   const { createPage, deletePage } = boundActionCreators
   const program = store.getState().program
   const pagesDirectory = systemPath.posix.join(program.directory, `/src/pages`)

diff --git a/packages/gatsby/src/redux/plugin-runner.js b/packages/gatsby/src/redux/plugin-runner.js
@@ -5,7 +5,7 @@ const apiRunnerNode = require(`../utils/api-runner-node`)
 
 emitter.on(`CREATE_NODE`, action => {
   const node = store.getState().nodes[action.payload.id]
-  apiRunnerNode(`onNodeCreate`, { node })
+  apiRunnerNode(`onCreateNode`, { node })
 })
 
 emitter.on(`CREATE_PAGE`, action => {

diff --git a/packages/gatsby/src/schema/build-node-types.js b/packages/gatsby/src/schema/build-node-types.js
@@ -122,7 +122,7 @@ module.exports = async () => {
     intermediateType.name = typeName
     intermediateType.nodes = nodes
 
-    const fieldsFromPlugins = await apiRunner(`extendNodeType`, {
+    const fieldsFromPlugins = await apiRunner(`setFieldsOnGraphQLNodeType`, {
       type: intermediateType,
       allNodes: getNodes(),
     })

diff --git a/packages/gatsby/src/utils/api-runner-node.js b/packages/gatsby/src/utils/api-runner-node.js
@@ -5,6 +5,8 @@ const mapSeries = require(`async/mapSeries`)
 
 const cache = require(`./cache`)
 
+const apiList = require(`./api-node-docs`)
+
 // Bind action creators per plugin so can auto-add plugin
 // meta-data to data they create.
 const boundPluginActionCreators = {}
@@ -49,7 +51,7 @@ const runAPI = (plugin, api, args) => {
 
   const gatsbyNode = require(`${plugin.resolve}/gatsby-node`)
   if (gatsbyNode[api]) {
-    // if (!_.includes([`onNodeCreate`, `onCreatePage`], api)) {
+    // if (!_.includes([`onCreateNode`, `onCreatePage`], api)) {
     // console.log(`calling api handler in ${plugin.resolve} for api ${api}`)
     // }
     const result = gatsbyNode[api](
@@ -79,6 +81,13 @@ const hasAPIFile = plugin => glob.sync(`${plugin.resolve}/gatsby-node*`)[0]
 
 module.exports = async (api, args = {}, pluginSource) =>
   new Promise(resolve => {
+    // Check that the API is documented.
+    if (!apiList[api]) {
+      console.log(`api`, api, `is not yet documented`)
+      // process.exit()
+      return resolve()
+    }
+
     const { store } = require(`../redux`)
     const plugins = store.getState().flattenedPlugins
     // Get the list of plugins that implement gatsby-node

diff --git a/www/gatsby-node.js b/www/gatsby-node.js
@@ -68,7 +68,7 @@ exports.createPages = ({ graphql, boundActionCreators }) => {
 }
 
 // Create slugs for files.
-exports.onNodeCreate = ({ node, boundActionCreators, getNode }) => {
+exports.onCreateNode = ({ node, boundActionCreators, getNode }) => {
   const { createNodeField } = boundActionCreators
   let slug
   if (node.internal.type === `File`) {