Add support for a help flag #28
Merged
Conversation
This file contains 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
orhun
approved these changes
Nov 15, 2023
not-an-aardvark
requested changes
Nov 16, 2023
|
Ran fmt, assuming it's good now. |
not-an-aardvark
approved these changes
Nov 17, 2023
While lucky-commit has a pretty simple interface, because it operates by side-effects it can be safer to check its behaviour. Currently, to get the help it's necessary to be lucky enough to mistakenly give it 2 args, thus failing to match any case. Otherwise, it will panic if called from not-within-a-repository, and silently rewrite the HEAD if invoked from one.
not-an-aardvark
force-pushed
the
help-flag
branch
from
5c313ba
to
0000000
Compare
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.
When I reach for a binary I don't use often, I usually start with a
man $binor$bin -h(/--help) to get my bearings and ensure I don't completely misuse the thing. This currently doesn't work with lucky-commit, resulting in a laconic(which admittedly is better than failing silently or doing something silly).
To get the help text it's necessary to be lucky enough to mistakenly give it 2 args, thus failing to match any case. I think it's not great, and having support for a help flag would be nice.