feat: Deprecate gatsby-recipes

deprecated-packages/gatsby-recipes/babel.config.js

@@ -0,0 +1,21 @@
+module.exports = api => {
+  const isTest = api.env(`test`)
+
+  return {
+    presets: [
+      [
+        `@babel/env`,
+        {
+          // use ES modules for rollup and commonjs for jest
+          modules: isTest ? `commonjs` : false,
+          shippedProposals: true,
+          targets: {
+            node: `10.13.0`,
+          },
+        },
+      ],
+      `@babel/preset-react`,
+    ],
+    plugins: [`@babel/plugin-transform-runtime`],
+  }
+}

packages/gatsby-recipes/components.js → deprecated-packages/gatsby-recipes/components.js

@@ -1,2 +1,2 @@
 const components = require(`./dist/web/components`)
-module.exports = components
+module.exports = components

packages/gatsby-recipes/rollup.config.js → deprecated-packages/gatsby-recipes/rollup.config.js

@@ -12,8 +12,8 @@ import path from "path"
 function excludeDevTools() {
   const re = /ink/
   return {
-    name: "ignoreDevTools",
-
+    name: `ignoreDevTools`,
+    // eslint-disable-next-line
     load(id) {
       if (id.match(re)) {
         if (path.parse(id).name === `devtools`) {
@@ -33,7 +33,7 @@ export default [
     output: {
       dir: `dist`,
       entryFileNames: `[name].js`,
-      format: "cjs",
+      format: `cjs`,
       sourcemap: true,
     },
     plugins: [
@@ -98,7 +98,7 @@ export default [
     output: {
       dir: `dist/web/`,
       entryFileNames: `[name].js`,
-      format: "es",
+      format: `es`,
       sourcemap: true,
     },
     plugins: [

packages/create-gatsby/README.md

@@ -1,4 +1,4 @@
-# create-gatsby (alpha)
+# create-gatsby
 
 Create Gatsby apps in an interactive CLI experience that does the plumbing for you.
 
@@ -18,7 +18,7 @@ yarn create gatsby
 
 It will ask you questions about what you're building, and set up a Gatsby project for you.
 
-_Note: this package is different from the Gatsby CLI, it is intended solely to create new sites._
+_Note: This package is different from `gatsby-cli`, it is intended solely to create new sites._
 
 ## Options
 
@@ -33,28 +33,34 @@ npm init gatsby -y <site-directory>
 If you're making changes to the create-gatsby package, you can follow the steps below to test out your changes locally:
 
 ```sh
-# Move into the create-gatsby package
-cd packages/create-gatsby
+# Move into the monorepo
+cd <path-to-gatsby-monorepo>
 
 # Install dependencies and build the package
-yarn && yarn build
+yarn bootstrap
 
 # Run the create-gatsby script
-node cli.js
+node packages/create-gatsby/cli.js
 ```
 
-Note that if you use the `build` script, you'll have to rebuild after each change. Alternatively, you can use the `watch` script to automatically rebuild after local changes. In that case, you'll need to run `cli.js` from the top-level directory of the `gatsby` repo:
+Note that if you use the `bootstrap` script, you'll have to rebuild after each change. Alternatively, you can use the `watch` script to automatically rebuild after local changes:
 
 ```sh
-# Move into the create-gatsby package
-cd packages/create-gatsby
+# Move into the monorepo
+cd <path-to-gatsby-monorepo>
 
 # Install dependencies and build the package
-yarn && yarn watch
+yarn bootstrap
 
-# Open another terminal window and get back to the gatsby monorepo
-cd <path-to-gatsby-monorepo>
+# Watch changes
+yarn watch --scope=create-gatsby
+```
+
+Open another terminal window and go to a folder where you can easily delete the test projects:
+
+```
+cd <path-to-playground>
 
 # Run the create-gatsby script
-node packages/create-gatsby/cli.js
+node <some-path/packages/create-gatsby/cli.js
 ```

packages/create-gatsby/src/site-metadata.ts

@@ -4,11 +4,11 @@ export async function setSiteMetadata(
   value: string
 ): Promise<void> {
   try {
-    const recipesPath = require.resolve(`gatsby-recipes`, {
+    const coreUtilsPath = require.resolve(`gatsby-core-utils`, {
       paths: [root],
     })
-    const { GatsbySiteMetadata } = require(recipesPath)
-    await GatsbySiteMetadata?.create({ root }, { name, value })
+    const { addFieldToMinimalSiteMetadata } = require(coreUtilsPath)
+    await addFieldToMinimalSiteMetadata({ root }, { name, value })
   } catch (e) {
     // Silently fail, as it's fine if we don't add it to the config
   }

packages/gatsby-cli/package.json

@@ -26,7 +26,6 @@
     "fs-exists-cached": "^1.0.0",
     "fs-extra": "^10.0.0",
     "gatsby-core-utils": "^3.3.0-next.1",
-    "gatsby-recipes": "^1.3.0-next.2",
     "gatsby-telemetry": "^3.3.0-next.1",
     "hosted-git-info": "^3.0.8",
     "is-valid-path": "^0.1.1",

packages/gatsby-cli/src/create-cli.ts

@@ -386,46 +386,15 @@ function buildLocalCommands(cli: yargs.Argv, isLocalSite: boolean): void {
     ),
   })
 
-  cli.command({
-    command: `recipes [recipe]`,
-    describe: `[EXPERIMENTAL] Run a recipe`,
-    builder: _ =>
-      _.option(`D`, {
-        alias: `develop`,
-        type: `boolean`,
-        default: false,
-        describe: `Start recipe in develop mode to live-develop your recipe (defaults to false)`,
-      }).option(`I`, {
-        alias: `install`,
-        type: `boolean`,
-        default: false,
-        describe: `Install recipe (defaults to plan mode)`,
-      }),
-    handler: handlerP(async ({ recipe, develop, install }: yargs.Arguments) => {
-      const { recipesHandler } = require(`./recipes`)
-      await recipesHandler(
-        siteInfo.directory,
-        recipe as string,
-        develop as boolean,
-        install as boolean
-      )
-    }),
-  })
-
   cli.command({
     command: `plugin <cmd> [plugins...]`,
     describe: `Useful commands relating to Gatsby plugins`,
     builder: yargs =>
-      yargs
-        .positional(`cmd`, {
-          choices: [`docs`, `ls`],
-          describe: "Valid commands include `docs`, `ls`.",
-          type: `string`,
-        })
-        .positional(`plugins`, {
-          describe: `The plugin names`,
-          type: `string`,
-        }),
+      yargs.positional(`cmd`, {
+        choices: [`docs`, `ls`],
+        describe: "Valid commands include `docs`, `ls`.",
+        type: `string`,
+      }),
     handler: async ({
       cmd,
     }: yargs.Arguments<{

packages/gatsby-cli/src/handlers/plugin.ts

@@ -1,34 +1,38 @@
-import { GatsbyPlugin } from "gatsby-recipes"
+import { listPlugins } from "gatsby-core-utils"
 import reporter from "../reporter"
 
 export default async (root: string, cmd: string | undefined): Promise<void> => {
   switch (cmd) {
     case `docs`:
       console.log(`
-        Using a plugin:
-        - What is a Plugin? (https://www.gatsbyjs.com/docs/what-is-a-plugin/)
-        - Using a Plugin in Your Site (https://www.gatsbyjs.com/docs/using-a-plugin-in-your-site/)
-        - What You Don't Need Plugins For (https://www.gatsbyjs.com/docs/what-you-dont-need-plugins-for/)
-        - Loading Plugins from Your Local Plugins Folder (https://www.gatsbyjs.com/docs/loading-plugins-from-your-local-plugins-folder/)
-        - Plugin Library (https://www.gatsbyjs.com/plugins/)
+Using a plugin:
+- What is a Plugin? (https://www.gatsbyjs.com/docs/what-is-a-plugin/)
+- Using a Plugin in Your Site (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/using-a-plugin-in-your-site/)
+- Loading Plugins from Your Local Plugins Folder (https://www.gatsbyjs.com/docs/loading-plugins-from-your-local-plugins-folder/)
+- Plugin Library (https://www.gatsbyjs.com/plugins/)
 
-        Creating a plugin:
-        - Naming a Plugin (https://www.gatsbyjs.com/docs/naming-a-plugin/)
-        - Files Gatsby Looks for in a Plugin (https://www.gatsbyjs.com/docs/files-gatsby-looks-for-in-a-plugin/)
-        - Creating a Generic Plugin (https://www.gatsbyjs.com/docs/creating-a-generic-plugin/)
-        - Creating a Local Plugin (https://www.gatsbyjs.com/docs/creating-a-local-plugin/)
-        - Creating a Source Plugin (https://www.gatsbyjs.com/docs/creating-a-source-plugin/)
-        - Creating a Transformer Plugin (https://www.gatsbyjs.com/docs/creating-a-transformer-plugin/)
-        - Submit to Plugin Library (https://www.gatsbyjs.com/contributing/submit-to-plugin-library/)
-        - Source Plugin Tutorial (https://www.gatsbyjs.com/tutorial/source-plugin-tutorial/)
-        - Maintaining a Plugin (https://www.gatsbyjs.com/docs/maintaining-a-plugin/)
-        - Join Discord #plugin-authoring channel to ask questions! (https://gatsby.dev/discord/)
-                   `)
+Creating a plugin:
+- Naming a Plugin (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/naming-a-plugin/)
+- Files Gatsby Looks for in a Plugin (https://www.gatsbyjs.com/docs/files-gatsby-looks-for-in-a-plugin/)
+- Creating a Generic Plugin (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/creating-a-generic-plugin/)
+- Creating a Local Plugin (https://www.gatsbyjs.com/docs/creating-a-local-plugin/)
+- Creating a Source Plugin (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/creating-a-source-plugin/)
+- Creating a Transformer Plugin (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/creating-a-transformer-plugin/)
+- Submit to Plugin Library (https://www.gatsbyjs.com/contributing/submit-to-plugin-library/)
+- Maintaining a Plugin (https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/maintaining-a-plugin/)
+- Join Discord #plugin-authoring channel to ask questions! (https://gatsby.dev/discord/)
+`)
       return
     case `ls`: {
       try {
-        const plugins = await GatsbyPlugin.all({ root }, false)
-        console.log(plugins)
+        const plugins = await listPlugins({ root })
+        let list = ``
+        plugins.forEach(plugin => (list += `- ${plugin}\n`))
+        console.log(`
+Following plugins are installed:
+
+${list}
+        `)
       } catch {
         reporter.error(
           `There was a problem parsing your \`gatsby-config.js\` file.\nIt may be malformed. Or, the syntax you're using is not currently supported by this command.`

packages/gatsby-cli/src/init-starter.ts

@@ -9,7 +9,7 @@ import isValid from "is-valid-path"
 import sysPath from "path"
 import prompts from "prompts"
 import url from "url"
-import { updateSiteMetadata } from "gatsby-core-utils"
+import { updateInternalSiteMetadata } from "gatsby-core-utils"
 import report from "./reporter"
 import { getPackageManager, setPackageManager } from "./util/package-manager"
 import reporter from "./reporter"
@@ -353,7 +353,7 @@ export async function initStarter(
       )
     })
 
-  await updateSiteMetadata(
+  await updateInternalSiteMetadata(
     {
       name: sitePackageJson?.name || rootPath,
       sitePath,

packages/gatsby-core-utils/package.json

@@ -35,6 +35,7 @@
     "file-type": "^16.5.3",
     "fs-extra": "^10.0.0",
     "got": "^11.8.2",
+    "lock": "^1.1.0",
     "node-object-hash": "^2.3.10",
     "proper-lockfile": "^4.1.2",
     "tmp": "^0.2.1",

packages/gatsby-core-utils/src/index.ts

@@ -15,3 +15,4 @@ export * from "./service-lock"
 export * from "./site-metadata"
 export * from "./page-data"
 export * from "./page-html"
+export { listPlugins } from "./list-plugins"