scobra

package

v0.26.0 Latest Latest Go to latest Published: Nov 30, 2023 License: Apache-2.0 Imports: 17 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/walteh/snake

Links

Open Source Insights

Documentation ¶

Index ¶

func DecorateTemplate(ctx context.Context, root *cobra.Command, cfg *DecorateOptions) (string, error)
func ExecuteHandlingError(ctx context.Context, cmd *CobraSnake)
func FormatCommandError(cmd *cobra.Command, err error) string
func HandleErrorByPrintingToConsole(cmd *cobra.Command, err error) error
func IsHandledByPrintingToConsole(err error) bool
func NewCommandResolver(s SCobra) snake.TypedResolver[SCobra]
func NewWrappedEnum(opt snake.Enum) *wrappedEnum
type CobraSnake
- func NewCobraSnake(ctx context.Context, root *cobra.Command) *CobraSnake
type DecorateOptions
type ErrHandledByPrintingToConsole
- func (e *ErrHandledByPrintingToConsole) Error() string
- func (e *ErrHandledByPrintingToConsole) Unwrap() error
type OutputHandler
- func NewOutputHandler(cmd *cobra.Command) *OutputHandler
type SCobra

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DecorateTemplate ¶

func DecorateTemplate(ctx context.Context, root *cobra.Command, cfg *DecorateOptions) (string, error)

Init patches Cobra's usage template with configuration provided.

func ExecuteHandlingError ¶

func ExecuteHandlingError(ctx context.Context, cmd *CobraSnake)

func FormatCommandError ¶

func FormatCommandError(cmd *cobra.Command, err error) string

func HandleErrorByPrintingToConsole ¶

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

func IsHandledByPrintingToConsole ¶

func IsHandledByPrintingToConsole(err error) bool

func NewCommandResolver ¶

func NewCommandResolver(s SCobra) snake.TypedResolver[SCobra]

func NewWrappedEnum ¶

func NewWrappedEnum(opt snake.Enum) *wrappedEnum

Types ¶

type CobraSnake ¶

type CobraSnake struct {
	RootCommand *cobra.Command
}

func NewCobraSnake ¶

func NewCobraSnake(ctx context.Context, root *cobra.Command) *CobraSnake

func (*CobraSnake) Decorate ¶

func (me *CobraSnake) Decorate(ctx context.Context, self SCobra, snk snake.Snake, inputs []snake.Input, mw []snake.Middleware) error

func (*CobraSnake) ManagedResolvers ¶

func (me *CobraSnake) ManagedResolvers(_ context.Context) []snake.Resolver

func (*CobraSnake) OnSnakeInit ¶

func (me *CobraSnake) OnSnakeInit(ctx context.Context, snk snake.Snake) error

func (*CobraSnake) ResolveEnum ¶

func (me *CobraSnake) ResolveEnum(typ string, opts []string) (string, error)

type DecorateOptions ¶

type DecorateOptions struct {
	Headings        *color.Color
	Commands        *color.Color
	CmdShortDescr   *color.Color
	ExecName        *color.Color
	Flags           *color.Color
	FlagsDataType   *color.Color
	FlagsDescr      *color.Color
	Aliases         *color.Color
	Example         *color.Color
	NoExtraNewlines bool
	NoBottomNewline bool
}

type ErrHandledByPrintingToConsole ¶

type ErrHandledByPrintingToConsole struct {
	// contains filtered or unexported fields
}

func (*ErrHandledByPrintingToConsole) Error ¶

func (e *ErrHandledByPrintingToConsole) Error() string

func (*ErrHandledByPrintingToConsole) Unwrap ¶

func (e *ErrHandledByPrintingToConsole) Unwrap() error

type OutputHandler ¶

type OutputHandler struct {
	// contains filtered or unexported fields
}

func NewOutputHandler ¶

func NewOutputHandler(cmd *cobra.Command) *OutputHandler

func (*OutputHandler) HandleFileOutput ¶

func (me *OutputHandler) HandleFileOutput(ctx context.Context, out *snake.FileOutput) error

HandleFileOutput implements sbind.OutputHandler.

func (*OutputHandler) HandleJSONOutput ¶

func (me *OutputHandler) HandleJSONOutput(ctx context.Context, out *snake.JSONOutput) error

func (*OutputHandler) HandleLongRunningOutput ¶

func (*OutputHandler) HandleLongRunningOutput(ctx context.Context, out *snake.LongRunningOutput) error

HandleLongRunningOutput implements sbind.OutputHandler.

func (*OutputHandler) HandleNilOutput ¶

func (me *OutputHandler) HandleNilOutput(ctx context.Context, out *snake.NilOutput) error

HandleNilOutput implements sbind.OutputHandler.

func (*OutputHandler) HandleRawTextOutput ¶

func (me *OutputHandler) HandleRawTextOutput(ctx context.Context, out *snake.RawTextOutput) error

HandleRawTextOutput implements sbind.OutputHandler.

func (*OutputHandler) HandleTableOutput ¶

func (me *OutputHandler) HandleTableOutput(ctx context.Context, out *snake.TableOutput) error

HandleTableOutput implements sbind.OutputHandler.

type SCobra ¶

type SCobra interface {
	Command() *cobra.Command
	Name() string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL