CLI: Use ink in CLI
#30202
CLI: Use ink in CLI
#30202
Conversation
|
View your CI Pipeline Execution ↗ for commit 4bf774d.
☁️ Nx Cloud last updated this comment at |
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 60 | 60 | 0 |
| Self size | 832 KB | 776 KB | 🎉 -56 KB 🎉 |
| Dependency size | 14.15 MB | 14.15 MB | 🚨 +31 B 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/core
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 54 | 54 | 0 |
| Self size | 19.09 MB | 19.60 MB | 🚨 +514 KB 🚨 |
| Dependency size | 14.43 MB | 14.72 MB | 🚨 +288 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 55 | 55 | 0 |
| Self size | 22 KB | 24 KB | 🚨 +2 KB 🚨 |
| Dependency size | 33.52 MB | 34.32 MB | 🚨 +802 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
sb
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 56 | 56 | 0 |
| Self size | 1 KB | 1 KB | 🎉 -2 B 🎉 |
| Dependency size | 33.54 MB | 34.35 MB | 🚨 +803 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 399 | 400 | 🚨 +1 🚨 |
| Self size | 503 KB | 248 KB | 🎉 -255 KB 🎉 |
| Dependency size | 75.57 MB | 77.52 MB | 🚨 +1.95 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 277 | 277 | 0 |
| Self size | 612 KB | 612 KB | 🎉 -2 B 🎉 |
| Dependency size | 65.37 MB | 66.17 MB | 🚨 +802 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
create-storybook
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 113 | 114 | 🚨 +1 🚨 |
| Self size | 1.11 MB | 1.86 MB | 🚨 +751 KB 🚨 |
| Dependency size | 42.66 MB | 43.86 MB | 🚨 +1.20 MB 🚨 |
| Bundle Size Analyzer | Link | Link |
…t reproduce locally
…/storybook into norbert/cli-with-ink
| .name('Initialize Storybook into your project.') | ||
| const createStorybookProgram = program.name('Initialize Storybook into your project.'); | ||
|
|
||
| const modernProgram = Object.entries(modernInputs.shape).reduce((acc, [key, schema]) => { |
There was a problem hiding this comment.
It's not immediately obvious what this reduce is for. Could you add a comment?
There was a problem hiding this comment.
This converts the zod runtime interface to a program.options()-chain for commander.
I added a comment higher up in the file.
| if (typeName.match('String')) { | ||
| acc.option(`--${flag} <option>`, description, value); | ||
| } else if (typeName.match('Enum')) { | ||
| acc.option(`--${flag} <option>`, description, value); | ||
| } else if (typeName.match('Boolean')) { | ||
| acc.option(`--${flag}`, description, value); | ||
| if (value === true) { | ||
| acc.option(`--no-${flag}`, `inverted --${flag}`); | ||
| } | ||
| } |
There was a problem hiding this comment.
Can't we extend modernInputs to include the legacy formats, so we don't have to map them here?
There was a problem hiding this comment.
This makes it easier to remove the legacy options, keeping them separate.
The legacy options don't use zod, and use the shorthand flags, which I'm not supporting here, since I don't deem it necessary.
I'm open to not using zod though, but this ensures we don't have any flags that do not result in state, as well as verify the user is passing valid options.
…fect. This simplifies the process, because we do not need to figure out which is the next step.
…already displayed)
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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>