common

Documentation

Index

• Constants
• func AddFailIfError(cmd *cobra.Command)
• func AddFailIfNotFoundFlag(cmd *cobra.Command)
• func AddModeFlag(cmd *cobra.Command)
• func Build(rts sdkservices.Runtimes, srcFS fs.FS, paths []string, syms []sdktypes.Symbol) (*sdkbuildfile.BuildFile, error)
• func BuildProject(project string, 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 FailIfError(cmd *cobra.Command, err error, whats ...string) error
• func FailIfNotFound(cmd *cobra.Command, what string, found bool) error
• func FailNotFound(cmd *cobra.Command, what string) error
• func GetMode() (m configset.Mode, 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 NewSvc(silent bool) (svc.Service, error)
• func NiceJSONRenderer(o any)
• func OpenURL(cmd *cobra.Command, link string) 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 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) Text() string
• type KVIfV
  • func (kv KVIfV[T]) MarshalJSON() ([]byte, error)
  • func (kv KVIfV[T]) Text() string
• type Renderer
• type Texter

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)

func Build

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

func BuildProject

func BuildProject(project string, 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 FailIfError

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

func FailIfNotFound

func FailIfNotFound(cmd *cobra.Command, what string, found bool) error

func FailNotFound

func FailNotFound(cmd *cobra.Command, what string) error

func GetMode

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

Get the mode initialized using AddModeFlag.

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)

Returns a new service initialized with dev mode.

func NewSvc

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

Returns a new service initialized with the mode set by AddModeFlag.

func NiceJSONRenderer

func NiceJSONRenderer(o any)

func OpenURL

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

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

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

func (kv KV) Text() 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]) Text

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

type Renderer

type Renderer func(any)

type Texter

type Texter interface{ Text() string }