refactor: generate flag help via flag.PrintDefaults - #14
Merged
Conversation
The usage output hard-coded descriptions for every flag, which drifted from the actual flag definitions. Delegate the flag listing to flag.PrintDefaults() so it stays in sync, and write usage to flag.CommandLine.Output() to match.
dobbi84
added
documentation
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
1 participant
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
printUsagehard-coded the description and default for every flag (--web.listen-address,--web.telemetry-path,--collector.*,--no-collector.*,--collector.disable-defaults). This duplicated the realflagdefinitions and would silently drift whenever a flag changed.Changes
flag.PrintDefaults(), which generates entries directly from the registered flags and their defaults — so they can't drift.flag.CommandLine.Output()(matching wherePrintDefaultswrites) instead of stdout viafmt.Println.Notes
flag.PrintDefaults()now lists each per-collector flag individually (more verbose than the old--collector.<name>placeholder), but it's accurate and self-maintaining.Testing
go build ./...✅go vet ./...✅