initialisation

Documentation

Index

• type InitData
  • func NewErrorInitData[T modconfig.ModTreeItem](err error) *InitData[T]
  • func NewInitData[T modconfig.ModTreeItem](ctx context.Context, cmd *cobra.Command, cmdArgs ...string) *InitData[T]
  • func (i *InitData[T]) Cleanup(ctx context.Context)
  • func (i *InitData[T]) GetSingleTarget() (modconfig.ModTreeItem, error)
  • func (i *InitData[T]) Init(ctx context.Context, args ...string)
  • func (i *InitData[T]) RegisterExporters(exporters ...export.Exporter) error
• type InitResult
  • func (r *InitResult) AddMessage(messages ...string)
  • func (r *InitResult) AddWarnings(warnings ...string)
  • func (r *InitResult) DisplayMessages()
  • func (r *InitResult) HasMessages() bool
  • func (r *InitResult) Merge(other InitResult)

Types

type InitData

type InitData[T modconfig.ModTreeItem] struct {
	Workspace       *workspace.Workspace
	WorkspaceEvents *dashboardworkspace.WorkspaceEvents
	Result          *InitResult

	ShutdownTelemetry func()
	ExportManager     *export.Manager
	Targets           []modconfig.ModTreeItem
	DefaultClient     *db_client.DbClient
}

func NewErrorInitData

func NewErrorInitData[T modconfig.ModTreeItem](err error) *InitData[T]

func NewInitData

func NewInitData[T modconfig.ModTreeItem](ctx context.Context, cmd *cobra.Command, cmdArgs ...string) *InitData[T]

func (*InitData[T]) Cleanup

func (i *InitData[T]) Cleanup(ctx context.Context)

func (*InitData[T]) GetSingleTarget

func (i *InitData[T]) GetSingleTarget() (modconfig.ModTreeItem, error)

GetSingleTarget validates there is only a single target and returns it

func (*InitData[T]) Init

func (i *InitData[T]) Init(ctx context.Context, args ...string)

func (*InitData[T]) RegisterExporters

func (i *InitData[T]) RegisterExporters(exporters ...export.Exporter) error

type InitResult

type InitResult struct {
	error_helpers.ErrorAndWarnings
	Messages []string

	// allow overriding of the display functions
	DisplayMessage func(ctx context.Context, m string)
	DisplayWarning func(ctx context.Context, w string)
}

func (*InitResult) AddMessage

func (r *InitResult) AddMessage(messages ...string)

func (*InitResult) AddWarnings

func (r *InitResult) AddWarnings(warnings ...string)

func (*InitResult) DisplayMessages

func (r *InitResult) DisplayMessages()

func (*InitResult) HasMessages

func (r *InitResult) HasMessages() bool

func (*InitResult) Merge

func (r *InitResult) Merge(other InitResult)