feat(gatsby-plugin-schema-snapshot): First version (#16561)

packages/gatsby-plugin-schema-snapshot/README.md

@@ -0,0 +1,53 @@
+# gatsby-plugin-schema-snapshot
+
+Create a snapshot of the GraphQL schema.
+
+Saves a minimal schema to file, adds the `@dontInfer` directive to all top-level types, and re-creates the schema from the saved type definitions during bootstrap. Use this plugin if you intend to lock-down a project's GraphQL schema.
+
+## Options
+
+All configuration options are optional.
+
+```js
+{
+  // Path where the type definitions will be saved to
+  path: `schema.gql`,
+  // include types by name, or all types owned by a plugin
+  include: {
+    types: [],
+    plugins: [],
+  },
+  // exclude types by name, or all types owned by a plugin
+  // by default, internal and built-in types are excluded
+  exclude: {
+    types: [],
+    plugins: [],
+  },
+  // ensure all field types are included
+  // dont't turn this off unless you have a very good reason to
+  withFieldTypes: true,
+  // manually control if a saved schema snapshot should be replaced with an
+  // updated version
+  update: false,
+}
+```
+
+## Example
+
+```js
+// gatsby-config.js
+module.exports = {
+  plugins: [
+    {
+      resolve: `gatsby-plugin-schema-snapshot`,
+      options: {
+        path: `schema.gql`,
+        exclude: {
+          plugins: [`gatsby-source-npm-package-search`],
+        },
+        update: process.env.GATSBY_UPDATE_SCHEMA_SNAPSHOT,
+      },
+    },
+  ],
+}
+```

packages/gatsby-plugin-schema-snapshot/gatsby-node.js

@@ -0,0 +1,35 @@
+const fs = require(`fs`)
+const path = require(`path`)
+
+exports.createSchemaCustomization = ({ actions, reporter }, options = {}) => {
+  const { createTypes, printTypeDefinitions } = actions
+
+  if (!printTypeDefinitions) {
+    reporter.error(
+      `\`gatsby-plugin-schema-snapshot\` needs Gatsby v2.13.55 or above.`
+    )
+    return
+  }
+
+  const filePath = path.resolve(options.path || `schema.gql`)
+
+  try {
+    if (fs.existsSync(filePath)) {
+      reporter.info(`Reading GraphQL type definitions from ${filePath}`)
+      const schema = fs.readFileSync(filePath, { encoding: `utf-8` })
+
+      createTypes(schema, { name: `default-site-plugin` })
+
+      if (options.update) {
+        fs.unlinkSync(filePath)
+        printTypeDefinitions(options)
+      }
+    } else {
+      printTypeDefinitions(options)
+    }
+  } catch (error) {
+    reporter.error(
+      `The plugin \`gatsby-plugin-schema-snapshot\` encountered an error`, error
+    )
+  }
+}

packages/gatsby-plugin-schema-snapshot/index.js

@@ -0,0 +1 @@
+// noop

packages/gatsby-plugin-schema-snapshot/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "gatsby-plugin-schema-snapshot",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "keywords": [
+    "gatsby",
+    "gatsby-plugin"
+  ],
+  "files": [
+    "gatsby-node.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gatsbyjs/gatsby.git",
+    "directory": "packages/gatsby-plugin-schema-snapshot"
+  },
+  "homepage": "https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-schema-snapshot#readme",
+  "peerDependencies": {
+    "gatsby": "^2.13.55"
+  }
+}

packages/gatsby/src/schema/print.js

@@ -150,6 +150,7 @@ const printTypeDefinitions = ({ config, schemaComposer }) => {
 
   try {
     typeDefs.forEach(tc => printedTypeDefs.push(printType(tc)))
+    report.info(`Writing GraphQL type definitions to ${path}`)
     return fs.writeFile(path, printedTypeDefs.join(`\n\n`))
   } catch (error) {
     report.error(`Failed writing type definitions to \`${path}\`.`, error)