cli(feat) Show help instead of errors when commands lack required args #511
Conversation
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
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #511 +/- ##
==========================================
+ Coverage 80.52% 80.62% +0.10%
==========================================
Files 16 16
Lines 2192 2199 +7
Branches 454 457 +3
==========================================
+ Hits 1765 1773 +8
+ Misses 277 276 -1
Partials 150 150 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
why: Improve developer experience by providing helpful guidance instead of cryptic argparse errors or confusing behavior when CLI commands are called without required arguments. what: - Add --all/-a flag to sync command (BREAKING: sync now requires --all to sync all repos, previously synced none silently) - Show help for sync when no patterns and --all not specified - Show help for search when no query terms provided (changed nargs="+" to "*") - Show help for add when no repo_path provided (added nargs="?") - Show help for discover when no scan_dir provided (added nargs="?") - Update tests to verify new help-on-empty behavior - Update CLI examples to show vcspull sync --all
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.
Summary
Improve developer experience by showing
--helpinstead of errors/confusing behavior when CLI commands are called without required arguments.Breaking Change:
vcspull syncnow requires--allto sync all repos. Previously it would silently sync nothing.Changes
vcspull syncvcspull searchvcspull addvcspull discoverImplementation
--all/-aflag to sync command--allnot specifiedvcspull sync --allTest plan
vcspull sync→ shows helpvcspull sync --all→ syncs all reposvcspull search→ shows helpvcspull add→ shows helpvcspull discover→ shows help