fix(cli): correct misleading docs and remove nonexistent --version hint#323
Open
alfredo-petri wants to merge 1 commit into
Open
fix(cli): correct misleading docs and remove nonexistent --version hint#323alfredo-petri wants to merge 1 commit into
alfredo-petri wants to merge 1 commit into
Conversation
cli/README.md described uipro init as downloading from GitHub by default. The current code uses template generation from bundled assets — GitHub is only used in the legacy ZIP mode which is not exposed as a CLI option. versions.ts advertised `uipro init --version <tag>` which is not a registered Commander option and does not work. - Rewrite How It Works section to match actual template-based behavior - Replace nonexistent --version hint with accurate usage tip Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
mrgoonie
requested changes
Jun 21, 2026
mrgoonie
left a comment
Contributor
There was a problem hiding this comment.
Summary: This PR correctly removes the nonexistent uipro init --version <tag> hint, but the README rewrite goes too far and now makes --offline look like a no-op even though it still changes behavior in the legacy ZIP install path.
Risk level: Medium
Mandatory gates:
- Duplicate/prior implementation: no merged duplicate found; search found this PR plus broader CLI/release PRs, but no prior fix for the exact
--versionhint + README wording. - Project standards: issue found — CLI docs should describe both default template mode and the remaining legacy/offline behavior accurately.
- Strategic necessity: clear value — avoiding nonexistent CLI flags and stale install docs reduces support churn.
- CI/checks: missing/not reported for this PR.
Findings:
- Important:
cli/src/commands/init.tsstill has a legacy ZIP-based install branch whereoptions.offlineskips the GitHub release download and falls back to bundled assets (if (options.legacy) { ... if (!options.offline) tryGitHubInstall(...) ... copyFolders(...) }). The PR README says--offlineis a no-op with the current default, but the public CLI no longer exposes--legacyincli/src/index.ts, so this wording is confusing from both directions: it documents internal behavior without explaining that the GitHub-download path is legacy-only/inaccessible from current public options. Please adjust the README/help text so it is precise, e.g. defaultinituses bundled template generation;--offlineis retained for compatibility and only affects legacy/package paths if those are exposed, or remove/clarify the flag separately.
Verdict: REQUEST_CHANGES
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.
Problem
Two pieces of documentation describe behavior that doesn't match the code:
1.
cli/README.md— wrong install mechanismThe current default path (
init.ts:179-183) usesgeneratePlatformFiles()— template generation from bundled assets. GitHub download only happens in the legacy ZIP mode (init.ts:160), which is not exposed as a CLI option. So--offlineis currently a no-op relative to the default.2.
cli/src/commands/versions.ts:34— advertises a nonexistent flag--versionis not a registered option inindex.tsfor theinitcommand. Running this would either use Commander's built-in--version(prints CLI version) or fail silently.Fix
--versionhint inversions.tswith an accurate tip🤖 Generated with Claude Code