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.
This PR reshapes help customization and usage-error handling against the API on
main.On
main, custom help isCommand.UsageFunc func(*Command) string, default help lives behindDefaultUsage, help detection re-exportsflag.ErrHelpascli.ErrHelp, command descriptions useShortHelp, and flag metadata usesFlagOption/Command.FlagOptions. This branch keeps core help automatic and string-based, while moving manual rendering and structured composition to the optionalusagepackage:Command.Help func(*Command) stringreplacesUsageFuncfor custom help.Command.DescriptionreplacesShortHelpfor command descriptions.--helpandcli.UsageErrorfstill print command help automatically.Parsereturnsflag.ErrHelpwhen callers handle help themselves.usage.Help(cmd)renders the same help textParseAndRunwould print for--help.usage.New(cmd)builds a composableusage.Documentfor adding sections like Examples.State.Cmdexposes the resolved command insideExec.FlagConfig/Command.FlagConfigsreplaceFlagOption/Command.FlagOptions.Why: the default path stays small, automatic, and out of the way. Callers that want richer help can opt into
usagewithout making structured documents part of the core API.Examples:
Breaking changes:
Command.UsageFunc; useCommand.Help.Command.ShortHelptoCommand.Description.DefaultUsageand the top-levelUsagefunction; useusage.Help(cmd)orusage.New(cmd).cli.ErrHelp; useflag.ErrHelp.FlagOptiontoFlagConfigandCommand.FlagOptionstoCommand.FlagConfigs.Closes #4, #14, #15.