Skip to content

Improve 19 error messages: fix typos, add actionable guidance, clarify wording#3345

Open
Balasubramanyamkosuri wants to merge 2 commits intojfrog:masterfrom
Balasubramanyamkosuri:balu
Open

Improve 19 error messages: fix typos, add actionable guidance, clarify wording#3345
Balasubramanyamkosuri wants to merge 2 commits intojfrog:masterfrom
Balasubramanyamkosuri:balu

Conversation

@Balasubramanyamkosuri
Copy link

Summary

  • Tier 1 — Typos & grammar (4 fixes): Fix "exit"→"exist", "Skiping"→"Skipping", redundant "latest", and "ID's"→"IDs" with improved reserved name error.
  • Tier 2 — Wording improvements (5 fixes): Clarify GitHub rate limit error with env var name, add version check suppression hint, reword confusing double-negative in fail-no-op, replace deprecated "API key" with "access token", update old binary name "jfrog" to "jf".
  • Tier 3 — Actionable guidance (10 fixes): Add examples/hints to --deb, Terraform, summary sections, lifecycle platform URL, Pipelines URL, CSV users create, users delete, build info modules, and Poetry sources errors.

Files Changed (8 files, 19 lines changed)

File Fixes
config/cli.go #1 typo, #19 reserved IDs, #20 API key→access token
plugins/utils/signatureutils.go #2 Skipping typo
utils/cliutils/utils.go #3 redundant latest, #4 rate limit, #5 version tag hint, #7 deb example, #12 fail-no-op
buildtools/cli.go #8 terraform commands, #11 jfrog→jf (2 occurrences)
general/summary/cli.go #10 valid sections list
artifactory/cli.go #13 platform URL hint, #15 CSV format, #16 users example
pipelines/cli.go #14 Pipelines remediation
utils/buildinfo/buildinfo.go #17 build info guidance, #18 Poetry recovery

Test Plan

  • Verify the project compiles: go build ./...
  • Grep for each old string to confirm no occurrences remain
  • Manual review of each changed line for correctness
  • Existing unit/integration tests pass (no behavioral changes, only string literals modified)

Made with Cursor

balukosuri and others added 2 commits February 10, 2026 20:46
…fy wording

Tier 1 - Typos and grammar:
- Fix "exit" -> "exist" typo in config/cli.go
- Fix "Skiping" -> "Skipping" typo in signatureutils.go
- Remove redundant "latest" in GitHub API error message
- Fix "ID's" -> "IDs" and improve reserved server ID error

Tier 2 - Wording improvements:
- Clarify GitHub rate limit error with env var name (JFROG_CLI_GITHUB_TOKEN)
- Add suppression hint for invalid version tag error
- Reword confusing double-negative in fail-no-op message
- Replace deprecated "API key" with "access token"
- Update old binary name "jfrog" to "jf" in config hint

Tier 3 - Actionable guidance:
- Add example to --deb option error (e.g., bionic/main/amd64)
- List supported Terraform commands in error
- List valid sections in summary error
- Add --url flag hint to lifecycle platform URL error
- Add remediation steps to Pipelines URL error
- Add CSV format hint to users create error
- Add usage example to users delete error
- Add build command guidance to "no modules" error
- Add Poetry source configuration hint

Co-authored-by: Cursor <cursoragent@cursor.com>
Go convention (enforced by staticcheck) requires error strings to not
end with punctuation. Removed trailing periods from three error messages.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Contributor

👍 Frogbot scanned this pull request and did not find any new security issues.


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.

2 participants