fncobra

Documentation

Index

• func CmdWithEnv(cmd *cobra.Command, f func(context.Context, cfg.Context, []string) error) *cobra.Command
• func ConsoleToSink(out *os.File, isTerm bool) (tasks.ActionSink, colors.Style, func())
• func DeferCheckVersion(ctx context.Context)
• func DoMain(name string, autoUpdate bool, registerCommands func(*cobra.Command))
• func EnvFromValue(cmd *cobra.Command, env *string) *cfg.Context
• func ListenPProf(debugSink io.Writer)
• func PushParse(cmd *cobra.Command, handler func(ctx context.Context, args []string) error)
• func PushPreParse(cmd *cobra.Command, handler func(ctx context.Context, args []string) error)
• func RegisterPprof(r *mux.Router)
• func RunE(handler CmdHandler) func(*cobra.Command, []string) error
• func RunInContext(ctx context.Context, handler func(context.Context) error) error
• func SetupContext(ctx context.Context) (context.Context, colors.Style, func())
• func SetupViper()
• func StandardConsole() (*os.File, bool)
• func With(cmd *cobra.Command, handler func(context.Context) error) *cobra.Command
• func WithSigIntCancel(ctx context.Context) (context.Context, func())
• type ArgsParser
  • func HardcodeEnv(envOut *cfg.Context, env string) ArgsParser
  • func ParseEnv(envOut *cfg.Context) ArgsParser
• type CmdHandler
• type CommandCtrl
  • func Cmd(cmd *cobra.Command) *CommandCtrl
  • func (c *CommandCtrl) Do(handler func(context.Context) error) *cobra.Command
  • func (c *CommandCtrl) DoWithArgs(handler CmdHandler) *cobra.Command
  • func (c *CommandCtrl) With(argParser ...ArgsParser) *CommandCtrl
  • func (c *CommandCtrl) WithFlags(f func(flags *pflag.FlagSet)) *CommandCtrl
• type Locations
  • func LocationsFromArgs(cmd *cobra.Command, env *cfg.Context, opts ...ParseLocationsOpts) *Locations
  • func ParseLocs(ctx context.Context, args []string, env *cfg.Context, opts ParseLocationsOpts) (*Locations, error)
• type LocationsParser
  • func ParseLocations(locsOut *Locations, env *cfg.Context, opts ...ParseLocationsOpts) *LocationsParser
  • func (p *LocationsParser) AddFlags(cmd *cobra.Command)
  • func (p *LocationsParser) Parse(ctx context.Context, args []string) error
• type ParseLocationsOpts
  • func MergeParseLocationOpts(opts []ParseLocationsOpts) ParseLocationsOpts

Functions

func CmdWithEnv

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

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

func ConsoleToSink

func ConsoleToSink(out *os.File, isTerm bool) (tasks.ActionSink, colors.Style, func())

func DeferCheckVersion

func DeferCheckVersion(ctx context.Context)

func DoMain

func DoMain(name string, autoUpdate bool, registerCommands func(*cobra.Command))

func EnvFromValue

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

func ListenPProf

func ListenPProf(debugSink io.Writer)

func PushParse

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

func PushPreParse

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

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

func SetupContext

func SetupContext(ctx context.Context) (context.Context, colors.Style, func())

func SetupViper

func SetupViper()

func StandardConsole

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

func With

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 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

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

func ParseLocs

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 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

func MergeParseLocationOpts(opts []ParseLocationsOpts) ParseLocationsOpts