feat(gatsby-plugin-typescript): Add schema (#27361)

* Add schema for gatsby-plugin-typescript * Update packages/gatsby-plugin-typescript/src/gatsby-node.js Co-authored-by: Matt Kane <matt@gatsbyjs.com> * eronuous curly braces * listen to experimental flag * update load plugins snapshot * update plugin test exepected result * add unit tests for schema Co-authored-by: Matt Kane <matt@gatsbyjs.com> Co-authored-by: gatsbybot <mathews.kyle+gatsbybot@gmail.com>
gatsbyjs · Oct 14, 2020 · 072ef6c · 072ef6c
1 parent 27ae3aa
commit 072ef6c
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/packages/gatsby-plugin-typescript/src/__tests__/gatsby-node.js b/packages/gatsby-plugin-typescript/src/__tests__/gatsby-node.js
@@ -5,6 +5,9 @@ const {
 } = require(`../gatsby-node`)
 const path = require(`path`)
 
+const { testPluginOptionsSchema } = require(`gatsby-plugin-utils`)
+const { pluginOptionsSchema } = require(`../gatsby-node`)
+
 describe(`gatsby-plugin-typescript`, () => {
   describe(`resolvableExtensions`, () => {
     it(`returns the correct resolvable extensions`, () => {
@@ -69,4 +72,32 @@ describe(`gatsby-plugin-typescript`, () => {
       expect(actions.setWebpackConfig).not.toHaveBeenCalled()
     })
   })
+
+  describe(`plugin schema`, () => {
+    it(`should provide meaningful errors when fields are invalid`, () => {
+      const expectedErrors = [
+        `"isTSX" must be a boolean`,
+        `"jsxPragma" must be a string`,
+        `"allExtensions" must be a boolean`,
+      ]
+
+      const { errors } = testPluginOptionsSchema(pluginOptionsSchema, {
+        isTSX: `this should be a boolean`,
+        jsxPragma: 123,
+        allExtensions: `this should be a boolean`,
+      })
+
+      expect(errors).toEqual(expectedErrors)
+    })
+
+    it(`should validate the schema`, () => {
+      const { isValid } = testPluginOptionsSchema(pluginOptionsSchema, {
+        isTSX: true,
+        jsxPragma: `ReactFunction`,
+        allExtensions: false,
+      })
+
+      expect(isValid).toBe(true)
+    })
+  })
 })
diff --git a/packages/gatsby-plugin-typescript/src/gatsby-node.js b/packages/gatsby-plugin-typescript/src/gatsby-node.js
@@ -35,6 +35,21 @@ function onCreateWebpackConfig({ actions, loaders }) {
   })
 }
 
+if (process.env.GATSBY_EXPERIMENTAL_PLUGIN_OPTION_VALIDATION) {
+  exports.pluginOptionsSchema = ({ Joi }) =>
+    Joi.object({
+      isTSX: Joi.boolean().description(`Enables jsx parsing.`).default(true),
+      jsxPragma: Joi.string()
+        .description(
+          `Replace the function used when compiling JSX expressions.`
+        )
+        .default(`React`),
+      allExtensions: Joi.boolean()
+        .description(`Indicates that every file should be parsed as TS or TSX.`)
+        .default(false),
+    })
+}
+
 exports.resolvableExtensions = resolvableExtensions
 exports.onCreateBabelConfig = onCreateBabelConfig
 exports.onCreateWebpackConfig = onCreateWebpackConfig
diff --git a/packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.ts.snap b/packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.ts.snap
@@ -202,6 +202,7 @@ Array [
     "id": "",
     "name": "gatsby-plugin-typescript",
     "nodeAPIs": Array [
+      "pluginOptionsSchema",
       "resolvableExtensions",
       "onCreateBabelConfig",
       "onCreateWebpackConfig",
@@ -478,6 +479,7 @@ Array [
     "id": "",
     "name": "gatsby-plugin-typescript",
     "nodeAPIs": Array [
+      "pluginOptionsSchema",
       "resolvableExtensions",
       "onCreateBabelConfig",
       "onCreateWebpackConfig",
@@ -762,6 +764,7 @@ Array [
     "id": "",
     "name": "gatsby-plugin-typescript",
     "nodeAPIs": Array [
+      "pluginOptionsSchema",
       "resolvableExtensions",
       "onCreateBabelConfig",
       "onCreateWebpackConfig",

diff --git a/packages/gatsby/src/bootstrap/load-plugins/__tests__/load-plugins.ts b/packages/gatsby/src/bootstrap/load-plugins/__tests__/load-plugins.ts
@@ -124,6 +124,7 @@ describe(`Load plugins`, () => {
             id: ``,
             name: `gatsby-plugin-typescript`,
             nodeAPIs: [
+              `pluginOptionsSchema`,
               `resolvableExtensions`,
               `onCreateBabelConfig`,
               `onCreateWebpackConfig`,
@@ -162,6 +163,7 @@ describe(`Load plugins`, () => {
             id: ``,
             name: `gatsby-plugin-typescript`,
             nodeAPIs: [
+              `pluginOptionsSchema`,
               `resolvableExtensions`,
               `onCreateBabelConfig`,
               `onCreateWebpackConfig`,