Documentation
¶
Overview ¶
Package cli provides error constructors for generic CLI input validation such as missing flags, arguments, and invalid selections.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ArgRequired ¶
ArgRequired returns an error for a missing required argument.
Parameters:
- name: the argument name
Returns:
- error: "<name> argument is required"
func FlagRequired ¶
FlagRequired returns an error for a missing required flag.
Parameters:
- name: the flag name
Returns:
- error: "required flag \"<name>\" not set"
func InvalidSelection ¶
InvalidSelection returns an error for an invalid interactive selection.
Parameters:
- input: the user's input
- max: the maximum valid selection number
Returns:
- error: "invalid selection: <input> (expected 1-<max>)"
func UnknownDocument ¶
UnknownDocument returns an error for an unrecognized document alias.
Parameters:
- alias: the unrecognized alias
Returns:
- error: "unknown document <alias> (available: manifesto, about, invariants)"
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.