Skip to content

Move [env: ...] label after flag description in --help#7991

Open
isaacroldan wants to merge 1 commit into
mainfrom
fix-env-vars-in-descriptions
Open

Move [env: ...] label after flag description in --help#7991
isaacroldan wants to merge 1 commit into
mainfrom
fix-env-vars-in-descriptions

Conversation

@isaacroldan

Copy link
Copy Markdown
Contributor

Since oclif 4.8, flag help renders the backing SHOPIFY_FLAG_* environment variable before the description, which pushes the description far to the right and hurts readability. Add a custom oclif help class that relocates the env label to the end of each flag's description, reusing oclif's own formatting for everything else. Wired via oclif.helpClass in package.json and emitted as a bundle entry point for the published CLI.

WHY are these changes introduced?

Fixes #0000

WHAT is this pull request doing?

How to test your changes?

Post-release steps

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

@isaacroldan isaacroldan requested review from a team as code owners July 3, 2026 11:11
@isaacroldan

Copy link
Copy Markdown
Contributor Author

/snapit

@github-actions github-actions Bot added the Area: @shopify/cli @shopify/cli package issues label Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🫰✨ Thanks @isaacroldan! Your snapshot has been published to npm.

Test the snapshot by installing your package globally:

pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20260703111232

Caution

After installing, validate the version by running shopify version in your terminal.
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

Since oclif 4.8, flag help renders the backing SHOPIFY_FLAG_* environment
variable before the description, which pushes the description far to the
right and hurts readability. Add a custom oclif help class that relocates
the env label to the end of each flag's description, reusing oclif's own
formatting for everything else. Wired via oclif.helpClass in package.json
and emitted as a bundle entry point for the published CLI.

Co-authored-by: Isaac Roldan <isaac.roldan@shopify.com>
Assisted-By: devx/70100ba5-800c-4ca4-82a2-a4cc73e13e03
@isaacroldan isaacroldan force-pushed the fix-env-vars-in-descriptions branch from c402362 to 0c4fa78 Compare July 3, 2026 11:26

@gonzaloriestra gonzaloriestra left a comment

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.

Working as expected 👌

@isaacroldan isaacroldan added this pull request to the merge queue Jul 3, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 3, 2026
@isaacroldan isaacroldan added this pull request to the merge queue Jul 3, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: @shopify/cli @shopify/cli package issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants