shared

Documentation

Index

• func ApplySanitizedHelpFuncRecursively(cmd *cobra.Command)
• func CmdCtxErr(cmd *cobra.Command) error
• func SetCmdCtxErr(cmd *cobra.Command, err error)
• func SetSanitizedHelpFunc(cmd *cobra.Command)
• func WrapText(text string, width int) string
• type CmdCtxKey

Functions

func ApplySanitizedHelpFuncRecursively

func ApplySanitizedHelpFuncRecursively(cmd *cobra.Command)

func CmdCtxErr

func CmdCtxErr(cmd *cobra.Command) error

CmdCtxErr returns the error stored in the command's context with SetCmdCtxErr.

func SetCmdCtxErr

func SetCmdCtxErr(cmd *cobra.Command, err error)

SetCmdCtxErr records the error in the command's context. Use CmdCtxErr to extract the error.

func SetSanitizedHelpFunc

func SetSanitizedHelpFunc(cmd *cobra.Command)

SetSanitizedHelpFunc remove backticks from the help text when printing to the console. The backticks are there for generated Docusaurus documentation, but they are odd for a user reading the help text in the console.

func WrapText

func WrapText(text string, width int) string

WrapText wraps text by the specified width

Types

type CmdCtxKey

type CmdCtxKey string

var (
	CmdCtxKeyCmdErr CmdCtxKey = "cmdErr"
)