CLI: Add skip onboarding, recommended/minimal config #30930

shilman · 2025-03-26T09:22:14Z

Closes N/A

What I did

Adds the following prompt to the CLI:

New to Storybook?
> Yes: Help me with onboarding
  No: Skip onboarding & don't ask me again

If the user wants help with onboarding, we'll install the "recommended" setup of dev/docs/test (skipping addon-test if unavailable).

If the user skips onboarding, we won't ask again, but we will prompt for what type of project they want to install:

What configuration should we install?
> Recommended: Component dev, docs, test
  Minimal: Dev only

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

Run STORYBOOK_TELEMETRY_DEBUG=1 $PROJECT_ROOT/code/lib/create-storybook/bin/index.cjs in an empty directory.

First time, it should prompt "New to storybook"? Answer yes & verify behavior + telemetry
Second time, it should prompt "New to storybook"? Answer no & verify output + telemetry
Third time, it should prompt "What configuration should we install?"
Delete the settings file and verify that any storybook command causes it to be recreated.

Documentation

Updated telemetry.mdx

🦋 Canary release

This pull request has been released as version 0.0.0-pr-30930-sha-9aa8a851. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information


Published version	`0.0.0-pr-30930-sha-9aa8a851`
Triggered by	@shilman
Repository	storybookjs/storybook
Branch	`shilman/cli-new-users`
Commit	`9aa8a851`
Datetime	Thu May 1 13:50:14 UTC 2025 (`1746107414`)
Workflow run	14776511435

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=30930

Greptile Summary

This PR introduces a new onboarding experience in Storybook's CLI, allowing users to choose between recommended and minimal configurations while tracking preferences through a new Settings system.

Added code/core/src/cli/globalSettings.ts for persistent user preferences with JSON storage and dot notation support
Added new CLI prompts in code/lib/create-storybook/src/initiate.ts for first-time users to opt into onboarding or choose configuration type
Added settingsCreatedAt field in telemetry metadata to track new user decisions
Updated telemetry notification message in notify-telemetry.ts for improved clarity
Added comprehensive test coverage for Settings class and CLI prompts

greptile-apps

_{8 file(s) reviewed, 9 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

code/core/src/cli/globalSettings.test.ts

code/core/src/cli/globalSettings.ts

code/core/src/telemetry/types.ts

greptile-apps · 2025-03-26T09:23:24Z

code/lib/create-storybook/src/initiate.test.ts

+});
+
+describe('promptInstallType', () => {
+  const settings = new Settings();


style: Settings instance should be initialized in beforeEach to ensure clean state between tests

greptile-apps · 2025-03-26T09:23:25Z

code/lib/create-storybook/src/initiate.test.ts

+  it('uses specific prompt options for React Native projects', async () => {
+    prompts.inject(['recommended']);
+    const result = await promptInstallType({
+      settings,
+      projectType: ProjectType.REACT_NATIVE,
+    });
+
+    expect(result).toBe('recommended');
+    expect(prompts).not.toHaveBeenCalled();
+    expect(vi.mocked(telemetry).mock.calls[0][1]).toMatchInlineSnapshot(`


logic: Test description suggests prompting but expects prompts not to be called - either the test name or implementation needs adjustment

greptile-apps · 2025-03-26T09:23:25Z

code/lib/create-storybook/src/initiate.test.ts

+  it('prompts user when interactive and yes option is not set', async () => {
+    prompts.inject(['recommended']);
+    const result = await promptInstallType({ settings });
+    expect(result).toBe('recommended');
+  });


style: Missing telemetry assertion in this test case while other similar tests verify it

Suggested change

it('prompts user when interactive and yes option is not set', async () => {

prompts.inject(['recommended']);

const result = await promptInstallType({ settings });

expect(result).toBe('recommended');

});

it('prompts user when interactive and yes option is not set', async () => {

prompts.inject(['recommended']);

const result = await promptInstallType({ settings });

expect(result).toBe('recommended');

expect(vi.mocked(telemetry).mock.calls[0][1]).toMatchInlineSnapshot({

installType: 'recommended',

step: 'install-type'

});

});

nx-cloud · 2025-03-26T09:27:29Z

View your CI Pipeline Execution ↗ for commit 9aa8a85.

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	1m 42s	View ↗

☁️ Nx Cloud last updated this comment at 2025-05-01 12:41:36 UTC

…loaded

…adata.

yannbf · 2025-05-01T14:44:12Z

code/core/src/cli/globalSettings.ts

+
+import { SavingGlobalSettingsFileError } from '../server-errors';
+
+const DEFAULT_SETTINGS_PATH = join(homedir(), '.storybook', 'settings.json');


I foresee issues if we ever use findUp for .storybook in different parts of the CLI and end up finding this package as if it is a config dir. We could be aware of this and try to always limit findUp to only go up until the gitRoot

CLI: Add skip onboarding, recommended/minimal config (cherry picked from commit dde78a0)

shilman added maintenance User-facing maintenance tasks cli labels Mar 26, 2025

shilman requested review from kylegach and jonniebigodes as code owners March 26, 2025 09:22

shilman added the ci:normal label Mar 26, 2025

greptile-apps bot reviewed Mar 26, 2025

View reviewed changes

valentinpalkovic assigned shilman Mar 31, 2025

shilman and others added 7 commits April 28, 2025 21:41

CLI: Optimize new vs existing users

e38e4e0

CLI: Rename init.promptNewUser to init.skipOnboarding

5b71fdf

Fix tests

413fb7e

Update settings to be a global singleton and to be saved as they are …

4534f85

…loaded

Parse global user settings with zod

3a9be7d

Update settings object to be closer to a simple typed POJO

2b4b41f

Fix call to settings in metadata

fbf5d2a

tmeasday force-pushed the shilman/cli-new-users branch from 514886d to fbf5d2a Compare April 28, 2025 11:42

tmeasday and others added 9 commits April 29, 2025 07:01

Add some extra tests to make sure we are sending userSince with met…

c41fca8

…adata.

Linting problems

f849550

Update frameworks.ts

76370d5

Update initiate.ts

b707e0a

Merge branch 'next' into shilman/cli-new-users

7212b6e

Fix feature flags

c147e4e

CLI: install a11y with test feature

71f0070

CLI: Always load global settings

fa9320f

Merge branch 'next' into shilman/cli-new-users

9aa8a85

yannbf reviewed May 1, 2025

View reviewed changes

tmeasday approved these changes May 2, 2025

View reviewed changes

shilman merged commit dde78a0 into next May 2, 2025
58 of 59 checks passed

shilman deleted the shilman/cli-new-users branch May 2, 2025 04:54

github-actions bot mentioned this pull request May 2, 2025

Release: Prerelease 9.0.0-beta.8 #31333

Merged

9 tasks

shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 14, 2025

github-actions bot mentioned this pull request May 14, 2025

Release: Patch 8.6.13 #31053

Merged

11 tasks

shilman added a commit that referenced this pull request May 14, 2025

Merge pull request #30930 from storybookjs/shilman/cli-new-users

31fcb75

CLI: Add skip onboarding, recommended/minimal config (cherry picked from commit dde78a0)

This was referenced May 16, 2025

Release: Patch 8.6.13 #31492

Closed

Release: Patch 8.6.14 #31494

Merged

github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

CLI: Add skip onboarding, recommended/minimal config #30930

CLI: Add skip onboarding, recommended/minimal config #30930

Uh oh!

shilman commented Mar 26, 2025 •

edited by storybook-bot

Loading

Uh oh!

greptile-apps bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greptile-apps bot Mar 26, 2025

Uh oh!

greptile-apps bot Mar 26, 2025

Uh oh!

greptile-apps bot Mar 26, 2025

Uh oh!

nx-cloud bot commented Mar 26, 2025 •

edited

Loading

Uh oh!

yannbf May 1, 2025

Uh oh!

Uh oh!

Uh oh!


		import { SavingGlobalSettingsFileError } from '../server-errors';

		const DEFAULT_SETTINGS_PATH = join(homedir(), '.storybook', 'settings.json');

Uh oh!

CLI: Add skip onboarding, recommended/minimal config #30930

CLI: Add skip onboarding, recommended/minimal config #30930

Uh oh!

Conversation

shilman commented Mar 26, 2025 • edited by storybook-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

🦋 Canary release

Greptile Summary

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greptile-apps bot Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yannbf May 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shilman commented Mar 26, 2025 •

edited by storybook-bot

Loading

nx-cloud bot commented Mar 26, 2025 •

edited

Loading