cmd

Documentation

Index

• Variables
• func RunClient(ctx context.Context, name string, opts ...fx.Option) error
• func RunServer(ctx context.Context, name string, opts ...fx.Option) error
• func SanitizeArgs(args []string) []string
• func SplitFlag(flag string) (string, string)
• func Start(lc fx.Lifecycle, fn StartFn)
• type Command
  • func New(name env.Name, version env.Version) *Command
  • func (c *Command) AddClient(name, description string, flags *FlagSet, opts ...fx.Option)
  • func (c *Command) AddServer(name, description string, flags *FlagSet, opts ...fx.Option)
  • func (c *Command) ExitOnError(args ...string)
  • func (c *Command) Run(args ...string) error
• type Config
  • func NewConfig(flag string, enc *encoding.Map, fs os.FileSystem) *Config
  • func (c *Config) Decode(data any) error
  • func (c *Config) Kind() string
  • func (c *Config) Write(data string, mode os.FileMode) error
• type ENV
  • func NewENV(location string, fs os.FileSystem) *ENV
  • func (e *ENV) Kind() string
  • func (e *ENV) Read() (string, error)
  • func (e *ENV) Write(data string, mode os.FileMode) error
• type File
  • func NewFile(location string, fs os.FileSystem) *File
  • func (f *File) Kind() string
  • func (f *File) Read() (string, error)
  • func (f *File) Write(data string, mode os.FileMode) error
• type FlagSet
  • func NewFlagSet(name string) *FlagSet
  • func (f *FlagSet) AddInput(value string)
  • func (f *FlagSet) AddOutput(value string)
  • func (f *FlagSet) Provide() *FlagSet
• type InputConfig
  • func NewInputConfig(set *FlagSet, enc *encoding.Map, fs os.FileSystem) *InputConfig
• type None
  • func NewNone() *None
  • func (*None) Kind() string
  • func (*None) Read() (string, error)
  • func (*None) Write(_ string, _ os.FileMode) error
• type OutputConfig
  • func NewOutputConfig(set *FlagSet, enc *encoding.Map, fs os.FileSystem) *OutputConfig
• type ReaderWriter
  • func NewReadWriter(kind, location string, fs os.FileSystem) ReaderWriter
• type StartFn

Variables

var ErrInvalidLocation = errors.New("invalid location (format kind:location)")

ErrInvalidLocation for cmd.

var ErrLocationMissing = errors.New("location is missing")

ErrLocationMissing for cmd.

var ErrNoEncoder = errors.New("config: no encoder")

ErrNoEncoder for cmd.

var Module = fx.Options(
	fx.Provide(NewInputConfig),
	fx.Provide(NewOutputConfig),
)

Module for fx.

Functions

func RunClient

func RunClient(ctx context.Context, name string, opts ...fx.Option) error

RunClient is a short lived process.

func RunServer

func RunServer(ctx context.Context, name string, opts ...fx.Option) error

RunServer is a long running process.

func SanitizeArgs

func SanitizeArgs(args []string) []string

SanitizeArgs removes all flags that start with -test.

func SplitFlag

func SplitFlag(flag string) (string, string)

SplitFlag for cmd.

func Start

func Start(lc fx.Lifecycle, fn StartFn)

Start for cmd.

Types

type Command

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

Command for application.

func New

func New(name env.Name, version env.Version) *Command

New command.

func (*Command) AddClient

func (c *Command) AddClient(name, description string, flags *FlagSet, opts ...fx.Option)

AddClient to the command.

func (*Command) AddServer

func (c *Command) AddServer(name, description string, flags *FlagSet, opts ...fx.Option)

AddServer to the command.

func (*Command) ExitOnError

func (c *Command) ExitOnError(args ...string)

ExitOnError will run the command and exit on error.

func (*Command) Run

func (c *Command) Run(args ...string) error

Run the command.

type Config

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

Config for cmd.

func NewConfig

func NewConfig(flag string, enc *encoding.Map, fs os.FileSystem) *Config

NewConfig for cmd.

func (*Config) Decode

func (c *Config) Decode(data any) error

Decode for config.

func (*Config) Kind

func (c *Config) Kind() string

Kind of config.

func (*Config) Write

func (c *Config) Write(data string, mode os.FileMode) error

Write for config.

type ENV

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

ENV for cmd.

func NewENV

func NewENV(location string, fs os.FileSystem) *ENV

NewENV for cmd.

func (*ENV) Kind

func (e *ENV) Kind() string

Kind for env.

func (*ENV) Read

func (e *ENV) Read() (string, error)

Read for env.

func (*ENV) Write

func (e *ENV) Write(data string, mode os.FileMode) error

Write for env.

type File

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

File for cmd.

func NewFile

func NewFile(location string, fs os.FileSystem) *File

NewFile for cmd.

func (*File) Kind

func (f *File) Kind() string

Kind for file.

func (*File) Read

func (f *File) Read() (string, error)

Read for file.

func (*File) Write

func (f *File) Write(data string, mode os.FileMode) error

Write for file.

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
}

FlagSet represents a set of defined flags.

func NewFlagSet

func NewFlagSet(name string) *FlagSet

NewFlagSet creates a new flag set with the given name.

func (*FlagSet) AddInput

func (f *FlagSet) AddInput(value string)

AddInput adds an input flag to the flag set.

func (*FlagSet) AddOutput

func (f *FlagSet) AddOutput(value string)

AddOutput adds an output flag to the flag set.

func (*FlagSet) Provide

func (f *FlagSet) Provide() *FlagSet

Provide returns the flag set.

type InputConfig

type InputConfig struct {
	*Config
}

InputConfig for cmd.

func NewInputConfig

func NewInputConfig(set *FlagSet, enc *encoding.Map, fs os.FileSystem) *InputConfig

NewInputConfig for cmd.

type None

type None struct{}

None for cmd.

func NewNone

func NewNone() *None

NewNone for cmd.

func (*None) Kind

func (*None) Kind() string

Kind for none.

func (*None) Read

func (*None) Read() (string, error)

Read for none.

func (*None) Write

func (*None) Write(_ string, _ os.FileMode) error

Write for none.

type OutputConfig

type OutputConfig struct {
	*Config
}

OutputConfig for cmd.

func NewOutputConfig

func NewOutputConfig(set *FlagSet, enc *encoding.Map, fs os.FileSystem) *OutputConfig

NewOutputConfig for cmd.

type ReaderWriter

type ReaderWriter interface {
	// Read bytes.
	Read() (string, error)

	// Write bytes with file's mode.
	Write(data string, mode os.FileMode) error

	// Kind of read writer.
	Kind() string
}

ReaderWriter for cmd.

func NewReadWriter

func NewReadWriter(kind, location string, fs os.FileSystem) ReaderWriter

NewReadWriter for cmd.

type StartFn

type StartFn func(ctx context.Context)

StartFn for cmd.