CLI: Don't add `@storybook/addon-links` by default #29177

tobiasdiez · 2024-09-21T15:43:22Z

What I did

The link addon is installed by default when initializing storybook using the cli. Thus, I think, it make sense to make it part of "@storybook/essential-addons". One less package whose version has to be synchronized with the main storybook version and makes manual installation a bit simpler as well.

But maybe there was a reason why it was not essential...sorry if I might reopen an old discussion, this was not my intention.

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

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

name	before	after	diff	z	%
createSize	0 B	0 B	0 B	-	-
generateSize	77.5 MB	77.5 MB	0 B	3.74	0%
initSize	162 MB	162 MB	-19.6 kB	0.27	0%
diffSize	85 MB	84.9 MB	-19.6 kB	-0.56	0%
buildSize	7.57 MB	7.57 MB	-2.11 kB	-1.14	0%
buildSbAddonsSize	1.66 MB	1.66 MB	-957 B	-1.06	-0.1%
buildSbCommonSize	195 kB	195 kB	0 B	-	0%
buildSbManagerSize	2.34 MB	2.34 MB	0 B	-	0%
buildSbPreviewSize	352 kB	352 kB	0 B	-	0%
buildStaticSize	0 B	0 B	0 B	-	-
buildPrebuildSize	4.55 MB	4.55 MB	-957 B	-1.06	0%
buildPreviewSize	3.02 MB	3.02 MB	-1.15 kB	-1.22	0%
testBuildSize	0 B	0 B	0 B	-	-
testBuildSbAddonsSize	0 B	0 B	0 B	-	-
testBuildSbCommonSize	0 B	0 B	0 B	-	-
testBuildSbManagerSize	0 B	0 B	0 B	-	-
testBuildSbPreviewSize	0 B	0 B	0 B	-	-
testBuildStaticSize	0 B	0 B	0 B	-	-
testBuildPrebuildSize	0 B	0 B	0 B	-	-
testBuildPreviewSize	0 B	0 B	0 B	-	-

name	before	after	diff	z	%
createTime	17.5s	23.4s	5.9s	1.08	25.4%
generateTime	22.8s	21.4s	-1s -377ms	0.82	-6.4%
initTime	14.6s	15.5s	910ms	-0.47	5.9%
buildTime	9.9s	11.1s	1.1s	-0.11	10.7%
testBuildTime	0ms	0ms	0ms	-	-
devPreviewResponsive	6.6s	6s	-536ms	-1.65	🔰-8.8%
devManagerResponsive	4.4s	4s	-333ms	-1.33	🔰-8.2%
devManagerHeaderVisible	782ms	662ms	-120ms	-1.88	🔰-18.1%
devManagerIndexVisible	817ms	693ms	-124ms	-1.83	🔰-17.9%
devStoryVisibleUncached	1.3s	1s	-321ms	-1.78	🔰-31.8%
devStoryVisible	816ms	694ms	-122ms	-1.81	🔰-17.6%
devAutodocsVisible	632ms	656ms	24ms	-1.04	3.7%
devMDXVisible	666ms	579ms	-87ms	-1.96	🔰-15%
buildManagerHeaderVisible	716ms	635ms	-81ms	-1.64	🔰-12.8%
buildManagerIndexVisible	722ms	641ms	-81ms	-1.68	🔰-12.6%
buildStoryVisible	782ms	670ms	-112ms	-1.78	🔰-16.7%
buildAutodocsVisible	664ms	596ms	-68ms	-1.44	🔰-11.4%
buildMDXVisible	652ms	576ms	-76ms	-1.48	🔰-13.2%

Greptile Summary

This PR marks the link addon as essential by incorporating it into the @storybook/addon-essentials package. Key changes include:

Removed '@storybook/addon-links' from various configuration files and examples
Added link addon to @storybook/addon-essentials package.json
Created new files in code/addons/essentials/src/links for manager and preview
Updated @storybook/addon-links package.json to include 'essentials' keyword
Simplified addon installation process in CLI and generators

These changes streamline Storybook setup by including the link addon by default, reducing manual configuration and version synchronization needs.

nx-cloud · 2024-09-21T15:47:28Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit dab6fd9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

nx run-many -t build --parallel=3

Sent with 💌 from NxCloud.

greptile-apps

LGTM

_{16 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

JReinhold · 2024-09-23T13:41:18Z

Thanks for this! You're actually touching upon something that we've discussed recently, except you're taking it in the opposite direction 😅

addon-links is very rarely used, so we've decided to take it out of default templates completely, see #29073

If you change up this PR to remove it from default addons and not add it to addon-essentials that would be fantastic! ❤️

tobiasdiez · 2024-09-23T14:33:36Z

Removing it from the default generator is an option as well 😄 I've done just that now.

It may be the case that it now has be added to the sandbox. Not sure how/where to do this best though.

JReinhold · 2024-09-23T14:58:25Z

Nice!

It may be the case that it now has be added to the sandbox. Not sure how/where to do this best though.

I think you can add it by concating 'link' to the addons array in this for loop:

https://github.com/storybookjs/storybook/blob/next/scripts/tasks/sandbox-parts.ts/#L178

jonniebigodes

@tobiasdiez, thank you for taking the time to put together this pull request and help with the documentation. I appreciate it 🙏 ! From my end (docs-wise), everything is good. I'm going to approve this, but I'll defer to the rest of the team for their input.

Hope you have a great day.

Stay safe

tobiasdiez · 2024-09-24T06:05:18Z

@JReinhold Thanks, but it seems this is actually not required (at least the test pass).

@jonniebigodes Thanks for the review!

JReinhold · 2024-09-25T20:25:17Z

@JReinhold Thanks, but it seems this is actually not required (at least the test pass).

I see. 🤔 This might be because we add resolutions for it too.

Mark the link addon as essential

3a8a5f5

tobiasdiez requested review from kylegach and jonniebigodes as code owners September 21, 2024 15:43

greptile-apps bot reviewed Sep 21, 2024

View reviewed changes

kasperpeulen assigned shilman and jonniebigodes Sep 23, 2024

JReinhold self-assigned this Sep 23, 2024

tobiasdiez added 2 commits September 23, 2024 22:24

Don't make link essentials

a15edaa

Merge remote-tracking branch 'upstream/next' into link-essentials

d27f14d

tobiasdiez changed the title ~~Mark the link addon as essential~~ Init: No longer add link addon by default Sep 23, 2024

jonniebigodes approved these changes Sep 23, 2024

View reviewed changes

tobiasdiez added cli addon: links ci:normal labels Sep 24, 2024

Merge branch 'next' into link-essentials

dab6fd9

JReinhold approved these changes Sep 25, 2024

View reviewed changes

JReinhold changed the title ~~Init: No longer add link addon by default~~ Init: Don't add @storybook/addon-links by default Sep 25, 2024

JReinhold added the maintenance User-facing maintenance tasks label Sep 25, 2024

JReinhold merged commit 5d43a85 into storybookjs:next Sep 25, 2024
54 of 57 checks passed

github-actions bot mentioned this pull request Sep 25, 2024

Release: Prerelease 8.4.0-alpha.2 #29210

Merged

10 tasks

tobiasdiez deleted the link-essentials branch September 26, 2024 02:23

shilman changed the title ~~Init: Don't add @storybook/addon-links by default~~ CLI: Don't add @storybook/addon-links by default Sep 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLI: Don't add `@storybook/addon-links` by default #29177

CLI: Don't add `@storybook/addon-links` by default #29177

tobiasdiez commented Sep 21, 2024 •

edited by storybook-pr-benchmarking bot

Loading

nx-cloud bot commented Sep 21, 2024 •

edited

Loading

greptile-apps bot left a comment

JReinhold commented Sep 23, 2024

tobiasdiez commented Sep 23, 2024

JReinhold commented Sep 23, 2024 •

edited

Loading

jonniebigodes left a comment

tobiasdiez commented Sep 24, 2024

JReinhold commented Sep 25, 2024

CLI: Don't add @storybook/addon-links by default #29177

CLI: Don't add @storybook/addon-links by default #29177

Conversation

tobiasdiez commented Sep 21, 2024 • edited by storybook-pr-benchmarking bot Loading

What I did

Checklist for Contributors

Testing

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

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Greptile Summary

nx-cloud bot commented Sep 21, 2024 • edited Loading

☁️ Nx Cloud Report

greptile-apps bot left a comment

Choose a reason for hiding this comment

JReinhold commented Sep 23, 2024

tobiasdiez commented Sep 23, 2024

JReinhold commented Sep 23, 2024 • edited Loading

jonniebigodes left a comment

Choose a reason for hiding this comment

tobiasdiez commented Sep 24, 2024

JReinhold commented Sep 25, 2024

CLI: Don't add `@storybook/addon-links` by default #29177

CLI: Don't add `@storybook/addon-links` by default #29177

tobiasdiez commented Sep 21, 2024 •

edited by storybook-pr-benchmarking bot

Loading

nx-cloud bot commented Sep 21, 2024 •

edited

Loading

JReinhold commented Sep 23, 2024 •

edited

Loading