fncobra

package
v0.0.374 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2024 License: Apache-2.0 Imports: 54 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CmdWithEnv

func CmdWithEnv(cmd *cobra.Command, f func(context.Context, cfg.Context, []string) error) *cobra.Command

Deprecated, use "ParseEnv"/"FixedEnv" instead.

func DefaultErrorFormatter added in v0.0.215

func DefaultErrorFormatter(out io.Writer, style colors.Style, err error)

func DeferCheckVersion added in v0.0.164

func DeferCheckVersion(ctx context.Context, command string)

func DoMain

func DoMain(opts MainOpts)

func EnvFromValue added in v0.0.135

func EnvFromValue(cmd *cobra.Command, env *string) *cfg.Context

func ListenPProf

func ListenPProf(infoSink io.Writer)

func PushParse added in v0.0.135

func PushParse(cmd *cobra.Command, handler func(ctx context.Context, args []string) error)

func PushPreParse added in v0.0.164

func PushPreParse(cmd *cobra.Command, handler func(ctx context.Context, args []string) error)

func RegisterPprof

func RegisterPprof(r *mux.Router)

func RunE

func RunE(handler CmdHandler) func(*cobra.Command, []string) error

func RunInContext added in v0.0.111

func RunInContext(ctx context.Context, handler func(context.Context) error) error

func SetupViper

func SetupViper()

func StandardConsole

func StandardConsole() (*os.File, bool)

func With added in v0.0.84

func With(cmd *cobra.Command, handler func(context.Context) error) *cobra.Command

func WithSigIntCancel

func WithSigIntCancel(ctx context.Context) (context.Context, func())

Types

type ArgsParser

type ArgsParser interface {
	AddFlags(*cobra.Command)
	Parse(ctx context.Context, args []string) error
}

func HardcodeEnv

func HardcodeEnv(envOut *cfg.Context, env string) ArgsParser

HardcodeEnv is a temporary facility to trigger context loading with a predefined environment name.

func ParseEnv

func ParseEnv(envOut *cfg.Context) ArgsParser

type CmdHandler

type CmdHandler func(context.Context, []string) error

type CommandCtrl

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

func Cmd

func Cmd(cmd *cobra.Command) *CommandCtrl

func (*CommandCtrl) Do

func (c *CommandCtrl) Do(handler func(context.Context) error) *cobra.Command

func (*CommandCtrl) DoWithArgs

func (c *CommandCtrl) DoWithArgs(handler CmdHandler) *cobra.Command

func (*CommandCtrl) With

func (c *CommandCtrl) With(argParser ...ArgsParser) *CommandCtrl

func (*CommandCtrl) WithFlags

func (c *CommandCtrl) WithFlags(f func(flags *pflag.FlagSet)) *CommandCtrl

type FormatErrorFunc added in v0.0.215

type FormatErrorFunc func(io.Writer, colors.Style, error)

type Locations

type Locations struct {
	Locations []fnfs.Location
	Refs      []*schema.PackageRef
	Root      *parsing.Root
	// Whether the user explicitly specified a list of locations.
	// If true, "All" can be not empty if "DefaultToAllWhenEmpty" is true
	UserSpecified bool
}

func LocationsFromArgs added in v0.0.135

func LocationsFromArgs(cmd *cobra.Command, env *cfg.Context, opts ...ParseLocationsOpts) *Locations

func ParseLocs added in v0.0.84

func ParseLocs(ctx context.Context, args []string, env *cfg.Context, opts ParseLocationsOpts) (*Locations, error)

type LocationsParser

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

func ParseLocations

func ParseLocations(locsOut *Locations, env *cfg.Context, opts ...ParseLocationsOpts) *LocationsParser

func (*LocationsParser) AddFlags

func (p *LocationsParser) AddFlags(cmd *cobra.Command)

func (*LocationsParser) Parse

func (p *LocationsParser) Parse(ctx context.Context, args []string) error

type MainOpts added in v0.0.221

type MainOpts struct {
	Name                 string
	AutoUpdate           bool
	NotifyOnNewVersion   bool
	FormatErr            FormatErrorFunc
	ConsoleInhibitReport bool
	ConsoleRenderer      consolesink.RendererFunc
	RegisterCommands     func(*cobra.Command)
}

type ParseLocationsOpts

type ParseLocationsOpts struct {
	// Verify that exactly one location is specified.
	RequireSingle bool
	// If true, and no locations are specified, then "workspace.ListSchemas" result is used.
	ReturnAllIfNoneSpecified bool
	// If true, package reference added to Refs
	SupportPackageRef bool
}

func MergeParseLocationOpts added in v0.0.84

func MergeParseLocationOpts(opts []ParseLocationsOpts) ParseLocationsOpts

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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