common

Documentation

Index

• Constants
• func AddFailIfError(cmd *cobra.Command)
• func AddFailIfNotFoundFlag(cmd *cobra.Command)
• func AddModeFlag(cmd *cobra.Command)
• func AddNotFoundErrIfCond(err error, found bool) error
• func Build(rts sdkservices.Runtimes, srcFS fs.FS, paths []string, syms []sdktypes.Symbol) (*sdkbuildfile.BuildFile, error)
• func BuildProject(pid sdktypes.ProjectID, dirPaths, filePaths []string) (sdktypes.BuildID, error)
• func Client() sdkservices.Services
• func Config() *svc.Config
• func ConfigYAMLFilePath() string
• func Consume(args []string) (data []byte, path string, err error)
• func GetToken() (string, error)
• func InitConfig(confmap map[string]any) (err error)
• func InitRPCClient(authToken string) (err error)
• func JSONRenderer(o any)
• func LimitedContext() (context.Context, context.CancelFunc)
• func NewDevSvc(silent bool) (svc.Service, error)
• func NewNonEmptyString(val string, p *string) *nonEmptyStringValue
• func NewSvc(silent bool) (svc.Service, error)
• func NiceJSONRenderer(o any)
• func OpenURL(cmd *cobra.Command, link string) error
• func ParseModeFlag() (m configset.Mode, err error)
• func Render(o any)
• func RenderKV(k string, v any)
• func RenderKVIfV[T any](k string, v T)
• func RenderList[T fmt.Stringer](ts []T)
• func ServerURL() *url.URL
• func SetRenderer(r Renderer)
• func StandardCommand(cmd *cobra.Command) *cobra.Command
• func StoreToken(token string) error
• func TextRenderer(o any)
• func ToExitCodeError(err error, whats ...string) error
• func ToExitCodeWithSkipNotFoundFlag(cmd *cobra.Command, err error, whats ...string) error
• func WithLimitedContext(ctx context.Context) (context.Context, context.CancelFunc)
• type ExitCodeError
  • func NewExitCodeError(code int, err error) ExitCodeError
  • func (e ExitCodeError) Error() string
• type KV
  • func (kv KV) MarshalJSON() ([]byte, error)
  • func (kv KV) ToString() string
• type KVIfV
  • func (kv KVIfV[T]) MarshalJSON() ([]byte, error)
  • func (kv KVIfV[T]) ToString() string
• type Renderer
• type ToStringer

Constants

const (
	EnvVarPrefix       = "AK_"
	ConfigYAMLFileName = "config.yaml"
)

const (
	NotFoundExitCode   = 10
	NotAMemberExitCode = NotFoundExitCode
	FailedPrecondition = 64
	GenericFailure     = 1
)

Functions

func AddFailIfError

func AddFailIfError(cmd *cobra.Command)

func AddFailIfNotFoundFlag

func AddFailIfNotFoundFlag(cmd *cobra.Command)

func AddModeFlag

func AddModeFlag(cmd *cobra.Command)

AddModeFlag adds the AutoKitteh service mode flag to the given CLI command. See also ParseModeFlag.

func AddNotFoundErrIfCond

func AddNotFoundErrIfCond(err error, found bool) error

keep given error, if passed or return notFound if !found condition

func Build

func Build(rts sdkservices.Runtimes, srcFS fs.FS, paths []string, syms []sdktypes.Symbol) (*sdkbuildfile.BuildFile, error)

func BuildProject

func BuildProject(pid sdktypes.ProjectID, dirPaths, filePaths []string) (sdktypes.BuildID, error)

func Client

func Client() sdkservices.Services

func Config

func Config() *svc.Config

func ConfigYAMLFilePath

func ConfigYAMLFilePath() string

func Consume

func Consume(args []string) (data []byte, path string, err error)

func GetToken

func GetToken() (string, error)

func InitConfig

func InitConfig(confmap map[string]any) (err error)

func InitRPCClient

func InitRPCClient(authToken string) (err error)

func JSONRenderer

func JSONRenderer(o any)

func LimitedContext

func LimitedContext() (context.Context, context.CancelFunc)

func NewDevSvc

func NewDevSvc(silent bool) (svc.Service, error)

NewDevSvc returns a new AutoKitteh service in dev mode.

func NewNonEmptyString

func NewNonEmptyString(val string, p *string) *nonEmptyStringValue

func NewSvc

func NewSvc(silent bool) (svc.Service, error)

Returns a new AutoKitteh service initialized with the mode defined by AddModeFlag and parsed by ParseModeFlag.

func NiceJSONRenderer

func NiceJSONRenderer(o any)

func OpenURL

func OpenURL(cmd *cobra.Command, link string) error

func ParseModeFlag

func ParseModeFlag() (m configset.Mode, err error)

ParseModeFlag returns the parsed value of the AutoKitteh service mode CLI flag, initialized with AddModeFlag.

func Render

func Render(o any)

func RenderKV

func RenderKV(k string, v any)

func RenderKVIfV

func RenderKVIfV[T any](k string, v T)

func RenderList

func RenderList[T fmt.Stringer](ts []T)

func ServerURL

func ServerURL() *url.URL

func SetRenderer

func SetRenderer(r Renderer)

func StandardCommand

func StandardCommand(cmd *cobra.Command) *cobra.Command

func StoreToken

func StoreToken(token string) error

func TextRenderer

func TextRenderer(o any)

func ToExitCodeError

func ToExitCodeError(err error, whats ...string) error

ToExitCodeError wraps the given error with an OS exit code. If the error is nil, it also returns nil.

func ToExitCodeWithSkipNotFoundFlag

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

ToExitCodeWithSkipNotFoundFlag returns the given command's error (may be nil) with an OS exit code, but considers the "--fail" flag: if set to false, we skip "not found" errors.

func WithLimitedContext

func WithLimitedContext(ctx context.Context) (context.Context, context.CancelFunc)

TODO(ENG-320): Configuration to disable timeout for debugging.

Types

type ExitCodeError

type ExitCodeError struct {
	Err  error
	Code int
}

func NewExitCodeError

func NewExitCodeError(code int, err error) ExitCodeError

func (ExitCodeError) Error

func (e ExitCodeError) Error() string

type KV

type KV struct {
	K string
	V any
}

func (KV) MarshalJSON

func (kv KV) MarshalJSON() ([]byte, error)

func (KV) ToString

func (kv KV) ToString() string

type KVIfV

type KVIfV[T any] struct {
	K string
	V T
}

This will not print anything if V is nil for text rendering. Should make output parsing easier for get operations. TODO: should we even care for non-json output parsing?

func (KVIfV[T]) MarshalJSON

func (kv KVIfV[T]) MarshalJSON() ([]byte, error)

func (KVIfV[T]) ToString

func (kv KVIfV[T]) ToString() string

type Renderer

type Renderer func(any)

type ToStringer

type ToStringer interface{ ToString() string }