fix: align leftovers with the command conventions - #1653
Conversation
- enumerated values in help are listed with commas, without "or" - errors no longer carry Go identifiers or an uppercase prefix - four errors wrap their cause with %w and read "cannot ..." - three log lines are capitalised sentences, one typo fixed - project worker, upgrade-check and admin-api declare their argument arity
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 6 minutes. View limit detailsLimit details: You’ve used all 2 included reviews currently available. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (19)
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe changes update CLI argument validation and help text, error wrapping and context, and log and warning messages. Most updates change messages; several errors now preserve the underlying error for unwrapping. ChangesCLI and error reporting
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Bug fix Suggested reviewers: Merge Risk: ⚪ Minimal · up to The command argument rules match the described interfaces, and the remaining changes clarify help text and errors without an identified behavior regression. No merge-blocking risk is evident. Security Architecture ReviewSecurity architecture risk: ⚪ Minimal · up to The reviewed changes tighten argument validation and improve error reporting without expanding credential access or file-writing authority. No material security risk was found to be introduced or worsened. Retained concerns Security review detailsSecurity Blast Radius
Trust Boundaries and Controls
Resilience and Maintainability Implications
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1653 +/- ##
==========================================
- Coverage 65.74% 65.73% -0.02%
==========================================
Files 462 462
Lines 30949 30949
==========================================
- Hits 20347 20343 -4
- Misses 10602 10606 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
somethings (lasomethingsomething)
left a comment
There was a problem hiding this comment.
just two edits; thank you Lena Forlin (@moshimorschi)!
|
Warning Threat Detection Engine Failure — The analysis engine could not complete. This is a tooling failure, not a security finding. What happenedThe threat detection engine failed to produce results. Review the workflow run logs for details. Reviewed this PR against Changed files: help text wording ( Why no doc update: These are text-only polish and internal error-wrapping changes per |
What changed?
Leftovers against docs/COMMAND_CONVENTIONS.md, no new behaviour except for stray arguments:
(a, b, c)without "or":project create --deploymentand--ci,project sql --format, and the(table, json)lists onproject extension list,project extension outdatedandaccount producer extension list.PrepareFolderForZipping,prepareShopwareForAsset(now names the file it could not create or write),downloadFileToand the uppercaseUnzip:.%winstead of%vand readcannot ...: public key generation, the changelog template, and the two store-push file errors.requierdtypo), the local override warning and the deprecated-login warning.project workerdeclares at most one argument,project upgrade-checknone,project admin-apiexplicitly any, since--output-tokenruns without arguments and extra ones are passed to curl.Screenshots
Why?
These are the spots the conventions guide still disagreed with after the September passes. Flags, defaults and output formats are untouched; the only visible change for users is that
workerandupgrade-checknow reject a stray argument instead of silently ignoring it.How was this tested?
go test ./...,golangci-lint run ./...and gofmt clean; one existing assertion updated to the new wording.project worker 5 extraandproject upgrade-check strayfail with exit 1,project admin-api --output-tokenandproject admin-api GET /path <curl args>behave as before.project validate --formatwording and the shared flag sentences are left to that PR.Related issue or discussion
#1652, #1642
Summary by CodeRabbit
Command-Line Improvements
Error Messages and Diagnostics