[Tracking]: Storybook Test onboarding via storybook init

[ghengeveld]

🧑‍🤝‍🧑 Who: @ghengeveld and @ndelangen

This is a tracking issue for the Onboard to Storybook Test via init project. Its purpose is to keep track of the overall status of the project and tasks and plan everything around it.

🏁 Goals

1. Simplify installation of Storybook Test by offering a zero-config setup in more complex projects. This includes Next.js users and custom Vite or Vitest setups. Right now the addon will fail to finish its postinstall step if it detects an unsupported scenario.
2. Improve visibility & awareness of Storybook Test. By making testing more prominent during initial Storybook setup, new users are more likely to adopt this capability, or at least be aware of its existence.
3. Gain insight into what users intend to use Storybook for, by explicitly asking this question during setup. Do they plan on using Storybook for testing, documentation, both, or just development?
4. Avoid installing unnecessary dependencies. Based on the intended use, we can intelligently install only the packages the user will need.
5. Improve the usability and maintainability of the Storybook CLI. Right now the CLI is poorly designed, hard to maintain, and not user-friendly. Its output is verbose, cluttered and inconsistent. This is an opportunity to address all those issues by completely reimplementing the init command of the CLI. We plan to use Ink which allows us to provide a rich, interactive experience while being able to develop in Storybook and use known React patterns.

🚩 Milestones

New init CLI

Preview Give feedback

1. Setup Ink as subsystem under the storybook ink CLI command
2. Configure our Storybook to render stories for Ink components
3. Scaffold interactive init user flow (questions, fake compatibility checks and dependency installation, mock result)
4. Support selecting options through CLI flags
5. Track metrics for user choices

Compatibility resolvers

Preview Give feedback

1. Package installaton based on user choices #30226
   +0
2. Update addon-essentials config according to user choices #30229
   +0
3. Prompt the user to install experimental-nextjs-vite in Next.js projects regardless of user choices #30228
   +0
4. [Needs information] Check compatibility before installing addon-test #30227
   +0
5. Install addon-test into existing Vite project (no Vitest)
6. Install addon-test into existing Vitest project with custom config
7. Install addon-test into Next.js project without experimental-nextjs-vite

Showcase testing in template stories

Preview Give feedback

1. Update header story with mocked auth logic and interaction assertions

create-storybook optimizations

Preview Give feedback

1. Don't depend on storybook in create-storybook
2. Don't depend on prettier to autoformat the main-config
3. Prebundle dependencies in create-storybook
4. Document npm create storybook instead of npx storybook init in docs

Other expandable scope

Preview Give feedback

1. Re-design the "Configure Your Project" page to highlight testing
2. CLI flag or option to skip generating template stories and omit addon-onboarding
3. CLI command to add test or docs capabilities to existing Storybook