Skip to content

CLI: Update CLI option descriptions#25723

Merged
valentinpalkovic merged 2 commits into
nextfrom
valentin/small-command-option-description-adjustments
Jan 23, 2024
Merged

CLI: Update CLI option descriptions#25723
valentinpalkovic merged 2 commits into
nextfrom
valentin/small-command-option-description-adjustments

Conversation

@valentinpalkovic
Copy link
Copy Markdown
Contributor

Closes N/A

What I did

Updated CLI option descriptions

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>

@valentinpalkovic valentinpalkovic self-assigned this Jan 23, 2024
@valentinpalkovic valentinpalkovic added documentation ci:normal Run our default set of CI jobs (choose this for most PRs). labels Jan 23, 2024
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@valentinpalkovic, thanks for taking the time to put together this pull request and help improve the CLI messaging by catching these small but rather important typos. Appreciate it 🙏 ! I left one small item for you to look into when you have a moment. I'm going to approve this to unblock you and get this merged when possible.

Comment thread code/lib/cli/src/generate.ts Outdated
.option('--package-manager <npm|pnpm|yarn1|yarn2>', 'Force package manager for installing deps')
.option('--use-pnp', 'Enable pnp mode for Yarn 2+')
.option('-p --parser <babel | babylon | flow | ts | tsx>', 'jscodeshift parser')
.option('-p --parser <babel | babylon | flow | ts | tsx>', 'Jscodeshift parser')
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@valentinpalkovic, one small item: can you revert Jscodeshift back to how it was? In this case, it was correct, the package is named as such and we should preserve it

Comment thread code/lib/cli/src/generate.ts Outdated
@valentinpalkovic valentinpalkovic merged commit a606619 into next Jan 23, 2024
@valentinpalkovic valentinpalkovic deleted the valentin/small-command-option-description-adjustments branch January 23, 2024 17:02
@github-actions github-actions Bot mentioned this pull request Jan 23, 2024
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:normal Run our default set of CI jobs (choose this for most PRs). documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants