Give the option to seed / scaffold cypress files on new project through UI

[jennifer-shehane]

Current behavior:

When running Cypress on a new project, Cypress automatically scaffolds out the cypress.json and cypress directory including example tests.

Desired behavior:

• On first cypress open, open dialog that asks if the project owner wants the scaffolding done for their project - "Yes, I need help setting up Cypress on this project", "No thanks, I know what I'm doing."
• Coupled with delivery of cypress init in the command line.
• If no scaffolding selected - explain to user how to get scaffolding back. Maybe a button in the UI that links them to docs on how to re-seed the project / OR / can just prompt the seeding of the project...
• If scaffolding selected - show modal of what was created in their project and where.
• Update Test Runner docs and Files docs about scaffolding options.

Versions

Cypress 3.1.5

Full internal proposal: https://github.com/cypress-io/cypress-internal/issues/363

[jennifer-shehane]

First design iteration:

[brian-mann]

I think it's a bit overwhelming to display all the stuff we're about to do when they haven't actually chosen that yet.

I'm thinking more along the lines of giving them the Yes/No, but underneath it hinting at what we will be doing which helps them make a choice.

So maybe something like...

This looks like a new project - would you like us to help you set it up?

     [No Thanks]                             [Yes, help me]
(I know what I'm doing)             We'll add example cypress tests for you
                                    and explain how to organize your files.

If they click "Yes" then on the next screen we'd then give the user a confirmation of what we just did with some tips on what each folder does and what we put in there.

Really these would just be brief descriptions of what each one is used for.

[jennifer-shehane]

New iteration

First modal

Second modal

I do not like this design - this should serve more as a starting off point for the design.

• What is the appropriate content for each folder's explanation?
• What's the best way to present this without slowing down the user's setup?
• Should we/how do we link them to learn more?

[jennifer-shehane]

New simplified iteration/idea for 2nd page with understanding that:

1. Only initializer of project will see this
2. Improve internal readme / something to explain purpose of more advanced files

[jennifer-shehane]

The work for this is done in #18924 but it hasn't yet been released. This will be part of our 10.0 release.

[cypress-bot]

Released in 10.0.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v10.0.0, please open a new issue.