integrations

Documentation

Index

• func Register(fmwk schema.Framework, i Integration)
• type DevObserver
• type HotReloadOpts
• type Integration
  • func IntegrationFor(fmwk schema.Framework) Integration
• type MaybeGenerate
  • func (MaybeGenerate) GenerateNode(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)
  • func (MaybeGenerate) GenerateServer(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)
• type MaybePrepare
  • func (MaybePrepare) PrepareBuild(context.Context, assets.AvailableBuildAssets, planning.Server, bool) (build.Spec, error)
  • func (MaybePrepare) PrepareRun(context.Context, planning.Server, *runtime.ContainerRunOpts) error
• type MaybeTidy
  • func (MaybeTidy) TidyNode(context.Context, cfg.Context, pkggraph.PackageLoader, *pkggraph.Package) error
  • func (MaybeTidy) TidyServer(context.Context, cfg.Context, pkggraph.PackageLoader, pkggraph.Location, ...) error
  • func (MaybeTidy) TidyWorkspace(context.Context, cfg.Context, []*pkggraph.Package) error
• type NoDev
  • func (NoDev) PrepareDev(ctx context.Context, _ runtime.ClusterNamespace, _ planning.PlannedServer) (context.Context, DevObserver, error)
  • func (NoDev) PrepareHotReload(context.Context, *wsremote.SinkRegistrar, planning.PlannedServer) *HotReloadOpts

Functions

func Register

func Register(fmwk schema.Framework, i Integration)

Types

type DevObserver

type DevObserver interface {
	io.Closer
	OnDeployment(context.Context)
}

type HotReloadOpts

type HotReloadOpts struct {
	Sink wsremote.Sink
	// If "eventProcessor" is set:
	//   - If it returns nil, a full rebuild will be triggered instead of a hot reload.
	//   - If it returns a non-nil event, that event will be used instead of the original event.
	EventProcessor func(*wscontents.FileEvent) *wscontents.FileEvent
}

type Integration

type Integration interface {
	parsing.FrameworkHandler

	// Called on `ns build`, `ns deploy`.
	PrepareBuild(context.Context, assets.AvailableBuildAssets, planning.PlannedServer, bool) (build.Spec, error)
	PrepareRun(context.Context, planning.PlannedServer, *runtime.ContainerRunOpts) error

	// Called on `ns tidy`
	TidyWorkspace(context.Context, cfg.Context, []*pkggraph.Package) error
	TidyNode(context.Context, cfg.Context, pkggraph.PackageLoader, *pkggraph.Package) error
	TidyServer(context.Context, cfg.Context, pkggraph.PackageLoader, pkggraph.Location, *schema.Server) error

	// Called on `ns generate`.
	GenerateNode(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)
	GenerateServer(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)

	// Called on `ns dev`.
	PrepareDev(context.Context, runtime.ClusterNamespace, planning.PlannedServer) (context.Context, DevObserver, error)
	PrepareHotReload(context.Context, *wsremote.SinkRegistrar, planning.PlannedServer) *HotReloadOpts
}

func IntegrationFor

func IntegrationFor(fmwk schema.Framework) Integration

type MaybeGenerate

type MaybeGenerate struct{}

func (MaybeGenerate) GenerateNode

func (MaybeGenerate) GenerateNode(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)

func (MaybeGenerate) GenerateServer

func (MaybeGenerate) GenerateServer(*pkggraph.Package, []*schema.Node) ([]*schema.SerializedInvocation, error)

type MaybePrepare

type MaybePrepare struct{}

func (MaybePrepare) PrepareBuild

func (MaybePrepare) PrepareBuild(context.Context, assets.AvailableBuildAssets, planning.Server, bool) (build.Spec, error)

func (MaybePrepare) PrepareRun

func (MaybePrepare) PrepareRun(context.Context, planning.Server, *runtime.ContainerRunOpts) error

type MaybeTidy

type MaybeTidy struct{}

func (MaybeTidy) TidyNode

func (MaybeTidy) TidyNode(context.Context, cfg.Context, pkggraph.PackageLoader, *pkggraph.Package) error

func (MaybeTidy) TidyServer

func (MaybeTidy) TidyServer(context.Context, cfg.Context, pkggraph.PackageLoader, pkggraph.Location, *schema.Server) error

func (MaybeTidy) TidyWorkspace

func (MaybeTidy) TidyWorkspace(context.Context, cfg.Context, []*pkggraph.Package) error

type NoDev

type NoDev struct{}

func (NoDev) PrepareDev

func (NoDev) PrepareDev(ctx context.Context, _ runtime.ClusterNamespace, _ planning.PlannedServer) (context.Context, DevObserver, error)

func (NoDev) PrepareHotReload

func (NoDev) PrepareHotReload(context.Context, *wsremote.SinkRegistrar, planning.PlannedServer) *HotReloadOpts