Fix CLI error handling and bash completion description leakage - #121
Merged
Merged
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
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.
Description
I improved the CLI's error handling by replacing
log.Fatalandlog.Fatalfcalls with directfmt.Fprintln(os.Stderr, err)andos.Exit(1). This change ensures that critical errors are always printed to stderr and the application exits with a non-zero status, addressing a silent failure mode whereslog's redirection oflogoutput could suppress fatal errors.I also removed the
-valias for theverboseflag inmain.goto prevent a collision withurfave/cli's built-in--versionflag, which caused the verbose flag to be silently ignored.Additionally, I fixed an issue in the bash shell completion script where descriptions from
urfave/cli's--generate-shell-completionoutput were incorrectly included as completion candidates. The script now usescut -d: -f1to strip these descriptions, ensuring only valid command/flag names are suggested.To verify the bash completion fix, I added a new integration test
TestBashCompletion_StripsDescriptionsthat executes the generated bash script in a real bash environment.Fixes #
Type of Change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Checklist
Test Plan & Evidence
Suggested Manual Verification
go test ./...and ensure all tests pass