feat: rename CLI command from dot to playground (with pg alias)#231
Merged
Conversation
Rename the CLI command from `dot` to `playground`, with `pg` as a short alias. Both names invoke the same binary, so `playground init` and `pg init` (and every other subcommand) are interchangeable. - install.sh saves the (still `dot-*`) release asset locally as `playground`, symlinks `pg` into both PATH bin dirs, removes any legacy `dot` install, and prints a yellow rounded-border box telling the user to run `playground init` or `pg init`. - update.ts self-update and e2e-post-release.yml agree on the `playground` installed filename; detectAsset() still resolves the `dot-*` download asset. - Sweep all user-facing runtime strings (errors, --help descriptions, TUI header breadcrumbs, terminal window titles, version-update banner) from `dot` to `playground`, with unit/e2e assertions and the telemetry expected-error regex updated in lockstep. - The old `dot` command is no longer installed.
Contributor
|
Dev build ready — try this branch: |
Contributor
E2E Test Pass · ❌ FAILTag:
❌ Failed tests (1)
Sentry traces: view spans for this run |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Renames the CLI command from
dottoplayground, withpgas a short alias. Both names invoke the same binary, soplayground initandpg init(and every other subcommand) are interchangeable. The olddotcommand is no longer installed.Why
dotcollides with too many existing tools and with Polkadot's own product family (tracked under the open "CLI command rename" item).playgroundis descriptive;pgkeeps a fast-to-type alias.How it works
Both commands after a curl install.
install.shdownloads the (stilldot-<os>-<arch>) release asset, saves it locally as~/.polkadot/bin/playground, and symlinkspg→ it in both~/.polkadot/binand~/.local/bin. It also removes any legacydotbinary/symlink from a prior install so the old command stops resolving on PATH.Release artifacts unchanged. GitHub release assets stay named
dot-*(download source); only the installed command names changed.update.ts(detectAsset()still returnsdot-*, dest is nowplayground) ande2e-post-release.ymlagree on theplaygroundinstalled filename, so self-update keeps the symlinks valid.Yellow "next step" box. At the end of the curl install, a yellow rounded-border box (styled to match the TUI's phone-signing
Callout) tells the user bothplayground initandpg initwork:User-facing string sweep. Every runtime message,
--helpdescription, TUI header breadcrumb (cmd="playground …"), terminal tab title, and the version-update banner now sayplayground. The telemetry expected-error regex and span name were updated in lockstep, with unit + e2e assertions updated to match.Scope notes
dot initetc. (non-functional), and the e2edescribe()/it()test titles (coupled to the CI-tfilter patterns ine2e.yml/e2e-local.sh). The e2e helper invokes the CLI viabun run src/index.tsdirectly, so it's unaffected.isExpectedCliErroronly matches the double-quote formrun "playground init", not the backtick form. Verified identical before/after this rename. Candidate for a separate follow-up.Verification
pnpm format:check✅pnpm lint:license✅pnpm test✅ 594 passed, 1 skippedpnpm build✅ compiles;playground --help/pg --versionconfirmed workingIncludes a
minorchangeset.