docs: document the flagsets.go/NewFlagSet wiring in the add-a-command recipes#79
Merged
Merged
Conversation
andyrewlee
force-pushed
the
audit/31-unknown-flag-pointer
branch
from
8fb3693 to
20e2539
Compare
… recipes Both 'add a command' recipes predate flagsets.go + Command.NewFlagSet and stop at 'add cmd/frob.go + a --json flag'. A contributor who follows the happy path to add a flag-bearing command gets machine help that reports only --json and a red make ci from TestCommandFlagsMatchExpected naming a file+table the recipe never introduced. Add the three-step wiring (frobFlagSet in flagsets.go, NewFlagSet in register, the expected-table entry), framed around keeping help in sync -- Run parses the flags either way.
andyrewlee
force-pushed
the
audit/32-document-flagsets-recipe
branch
from
3445c78 to
bb0df97
Compare
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.
Both 'add a command' recipes predate flagsets.go + Command.NewFlagSet and stop
at 'add cmd/frob.go + a --json flag'. A contributor who follows the happy path
to add a flag-bearing command gets machine help that reports only --json and a
red make ci from TestCommandFlagsMatchExpected naming a file+table the recipe
never introduced. Add the three-step wiring (frobFlagSet in flagsets.go,
NewFlagSet in register, the expected-table entry), framed around keeping help in
sync -- Run parses the flags either way.
Part of a 38-PR stacked diff (
audit/01…audit/38), reviewed and merged bottom-up. This PR is based onaudit/31-unknown-flag-pointer.