gatsby plugin wizard produces invalid project

[pelikhan]

Description

I am following the steps to create a stand alone plugin in https://www.gatsbyjs.com/docs/creating-a-local-plugin/#developing-a-local-plugin-that-is-outside-your-project and it is resulting in a file structure that is not recognized as a gatsby site.

Steps to reproduce

❯ gatsby new gatsby-remark-makecode https://github.com/gatsbyjs/gatsby-starter-plugin
info Creating new site from git:
Cloning into 'gatsby-remark-makecode'...
remote: Enumerating objects: 12, done.
remote: Counting objects: 100% (12/12), done.
remote: Compressing objects: 100% (11/11), done.
remote: Total 12 (delta 1), reused 6 (delta 0), pack-reused 0
Unpacking objects: 100% (12/12), done.
success Created starter directory layout
info Installing packages...
npm WARN ancient lockfile 
npm WARN ancient lockfile The package-lock.json file was created with an old version of npm,
npm WARN ancient lockfile so supplemental metadata must be fetched from the registry.
npm WARN ancient lockfile 
npm WARN ancient lockfile This is a one-time fix-up, please be patient...
npm WARN ancient lockfile 

up to date, audited 1 package in 324ms

found 0 vulnerabilities
info Initialising git in gatsby-remark-makecode
Initialized empty Git repository in /Users/peli/Documents/gatsby-remark-makecode/.git/
info Create initial git commit in gatsby-remark-makecode
info
Your new Gatsby site has been successfully bootstrapped. Start developing it by
running:

  cd gatsby-remark-makecode
  gatsby develop
❯ cd gatsby-remark-makecode
❯ code .
❯ gatsby develop

 ERROR 

gatsby develop

Start development server. Watches files, rebuilds, and hot reloads if something changes

Options:
  --verbose                   Turn on verbose output                                 [boolean] [default: false]
  --no-color, --no-colors     Turn off the color in output                           [boolean] [default: false]
  --json                      Turn on the JSON logger                                [boolean] [default: false]
  -H, --host                  Set host. Defaults to localhost                   [string] [default: "localhost"]
  -p, --port                  Set port. Defaults to 8000                             [string] [default: "8000"]
  -o, --open                  Open the site in your (default) browser for you.                        [boolean]
  -S, --https                 Use HTTPS. See https://www.gatsbyjs.org/docs/local-https/ as a guide    [boolean]
  -c, --cert-file             Custom HTTPS cert file (also required: --https, --key-file). See
                              https://www.gatsbyjs.org/docs/local-https/                 [string] [default: ""]
  -k, --key-file              Custom HTTPS key file (also required: --https, --cert-file). See
                              https://www.gatsbyjs.org/docs/local-https/                 [string] [default: ""]
  --ca-file                   Custom HTTPS CA certificate file (also required: --https, --cert-file,
                              --key-file).  See https://www.gatsbyjs.org/docs/local-https/
                                                                                         [string] [default: ""]
  --graphql-tracing           Trace every graphql resolver, may have performance implications
                                                                                     [boolean] [default: false]
  --open-tracing-config-file  Tracer configuration file (OpenTracing compatible). See
                              https://gatsby.dev/tracing                                               [string]
  --inspect                   Opens a port for debugging. See
                              https://www.gatsbyjs.org/docs/debugging-the-build-process/
                                                                                       [number] [default: 9229]
  --inspect-brk               Opens a port for debugging. Will block until debugger is attached. See
                              https://www.gatsbyjs.org/docs/debugging-the-build-process/
                                                                                       [number] [default: 9229]
  -h, --help                  Show help                                                               [boolean]
  -v, --version               Show the version of the Gatsby CLI and the Gatsby package in the current project
                                                                                                      [boolean]


 ERROR 

gatsby <develop> can only be run for a gatsby site.
Either the current working directory does not contain a valid package.json or 'gatsby' is not specified as a dependency

Expected result

What should happen?

Actual result

What happened.

Environment

Run gatsby info --clipboard in your project directory and paste the output here.

❯ gatsby info --clipboard

 ERROR 

UNHANDLED REJECTION (e || []).filter is not a function



  TypeError: (e || []).filter is not a function
  
  - envinfo.js:1 
    [lib]/[gatsby]/[envinfo]/dist/envinfo.js:1:73314
  
  - task_queues.js:93 processTicksAndRejections
    internal/process/task_queues.js:93:5
  
  - async Promise.all

❯ node -v
v14.15.4

[LekoArts]

Hi!

The section you're referring to is under the heading "Developing a local plugin that is outside your project". So the following steps assume that you want to develop the plugin outside of your project itself. The starter you are copying there is only a plugin, not a Gatsby site. It doesn't contain any pages nor a "start"/"build" script.

The site that requires the local plugin (https://www.gatsbyjs.com/docs/creating-a-local-plugin/#using-requireresolve-and-a-filepath) is the site that you should run with "gatsby develop".

[LekoArts]

Ah, yeah, that makes sense that it's confusing. If you're up for it a PR that changes the gatsby new to a git clone + npm install would probably resolve that problem :)

[pelikhan]

There are 135 instance of "gatsby new", not clear where to start.

[LekoArts]

Oh, only for that paragraph in that guide! :) The other instances of gatsby new are correct

[pelikhan]

The cli output is the problem, not just the guide.

[LekoArts]

No, I think you're misunderstanding me here.

The CLI output is fine because all other guides use gatsby new for its intended purpose, that is: Cloning and installing a valid Gatsby site/starter.

In this guide's instance the project is not a valid Gatsby project as it's a plugin, so gatsby new is incorrect to use here.