Skip to content

fix(contract): clarify command help text#412

Merged
UtkarshBhardwaj007 merged 1 commit into
mainfrom
fix/contract-help-text
Jun 17, 2026
Merged

fix(contract): clarify command help text#412
UtkarshBhardwaj007 merged 1 commit into
mainfrom
fix/contract-help-text

Conversation

@UtkarshBhardwaj007

Copy link
Copy Markdown
Member

Summary

Fixes #270 — the contract command's --help listing was opaque:

contract                Run CDM contract workflows

Two problems the DevEx audit flagged:

  1. "CDM" means nothing to a new user — replaced with plain English.
  2. No <command> hint, so it wasn't obvious contract takes subcommands (deploy, install).

Change

In src/commands/contract.ts:

.description("Install and deploy smart contract libraries for your app")
.usage("<command> [options]")

Rendered help now reads:

Usage: contract <command> [options]

Install and deploy smart contract libraries for your app

Verification

  • pnpm format:check, pnpm lint:license, pnpm typecheck — clean
  • pnpm test — 973 passed (90 files)
  • Help output verified by rendering contractCommand
  • Changeset included (patch)

Replace the opaque 'Run CDM contract workflows' description with plain
English and add a '<command> [options]' usage hint so the deploy/install
subcommands are discoverable from 'playground --help'.

Closes #270
@UtkarshBhardwaj007 UtkarshBhardwaj007 merged commit 58eef2a into main Jun 17, 2026
18 of 20 checks passed
@UtkarshBhardwaj007 UtkarshBhardwaj007 deleted the fix/contract-help-text branch June 17, 2026 13:42
@github-actions

Copy link
Copy Markdown
Contributor

E2E Test Pass · ❌ FAIL

Tag: e2e-ci-pr · Branch: fix/contract-help-text · Commit: d68f7b0 · Run logs

Cell Result Time
pr-deploy-frontend ❌ FAIL 16m17s
pr-login-session ✅ PASS 2m40s
pr-deploy-foundry ✅ PASS 0m56s
pr-install ✅ PASS 1m03s
pr-deploy-cdm ✅ PASS 5m05s
pr-mod ✅ PASS 2m59s
pr-preflight ✅ PASS 3m34s
${{ matrix.cell }} ⏭️ SKIP 0m-1s
${{ matrix.cell }} ⏭️ SKIP 0m-1s

Sentry traces: view spans for this run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] 'contract' command description opaque ('CDM') + subcommands invisible

1 participant