plugin

package

v0.0.33 Latest Latest Go to latest Published: Dec 20, 2024 License: GPL-3.0 Imports: 21 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/unstoppablemango/tdl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func FilterSupported(seq iter.Seq[tdl.Plugin], target tdl.Target) iter.Seq[tdl.Plugin]
func Find[T tdl.Plugin](plugins iter.Seq[tdl.Plugin], pred Predicate[T]) (res T, found bool)
func FromPath(name string) *fromPath
func Generator(ctx context.Context, plugin tdl.Plugin, target tdl.Target) (tdl.Generator, error)
func HasKey(plugin tdl.Plugin, key string) bool
func HasMetaValue(plugin tdl.Plugin, key, value string) bool
func MatchesName(plugin tdl.Plugin, name string) bool
func MetaValue(plugin tdl.Plugin, key string) (string, bool)
func MetaValues(plugin tdl.Plugin) iter.Seq2[string, string]
func OfType[T tdl.Plugin](seq iter.Seq[tdl.Plugin]) iter.Seq[T]
func ParseToken(token string) (tdl.Plugin, error)
func ParseUrl(url *url.URL) (tdl.Plugin, error)
func Pull(ctx context.Context, plugin tdl.Plugin, options ...PullOption) error
func PullToken(ctx context.Context, name string, options ...PullOption) error
func Sorted[O Ordered](seq iter.Seq[O]) []O
func Static() iter.Seq[tdl.Plugin]
func Subscribe[F progress.Func](plugin tdl.Plugin, handler F) rx.Subscription
func SupportsLang(plugin tdl.Plugin, lang string) bool
func Tool(ctx context.Context, plugin tdl.Plugin, target tdl.Target) (tdl.Tool, error)
func TrySubscribe[F progress.Func](plugin tdl.Plugin, handler F) (rx.Subscription, bool)
func Unwrap(plugin tdl.Plugin) []tdl.Plugin
func UnwrapAll(plugins []tdl.Plugin) []tdl.Plugin
func UnwrapEach(plugins iter.Seq[tdl.Plugin]) iter.Seq[tdl.Plugin]
type Aggregate
- func NewAggregate(plugins ...tdl.Plugin) Aggregate
- func (a Aggregate) Meta() tdl.Meta
- func (a Aggregate) Prepare(ctx context.Context) error
- func (a Aggregate) String() string
- func (a Aggregate) Supports(target tdl.Target) bool
type GeneratorPlugin
type Observable
- func Observe(plugin tdl.Plugin) Observable
- func TryObserve(plugin tdl.Plugin) (Observable, bool)
type Ordered
- func AsOrdered(plugin tdl.Plugin) Ordered
- func WithPriority(plugin tdl.Plugin, priority int) Ordered
type Predicate
type PullOption
- func WithProgress(progress rx.Observer[progress.Event]) PullOption
type PullOptions
type ToolPlugin

Constants ¶

View Source

const UnwrapDepth = 3

Variables ¶

View Source

var Crd2Pulumi tdl.Plugin = NewAggregate(
	fromPath{name: "crd2pulumi", stdout: false},
	github.NewRelease("crd2pulumi-v1.5.4-linux-amd64.tar.gz", "1.5.4",
		github.WithOwner("pulumi"),
		github.WithRepo("crd2pulumi"),
		github.WithArchiveContents("crd2pulumi"),
	),
)

View Source

var Uml2Ts tdl.Plugin = NewAggregate(
	fromPath{name: "uml2ts", stdout: true},
	github.NewRelease("tdl-linux-amd64.tar.gz", "0.0.32",
		github.WithArchiveContents("uml2ts"),
	),
	docker.New(nil, "ghcr.io/unstoppablemango/uml2ts:v0.0.32"),
)

Functions ¶

func FilterSupported ¶ added in v0.0.33

func FilterSupported(seq iter.Seq[tdl.Plugin], target tdl.Target) iter.Seq[tdl.Plugin]

func Find ¶ added in v0.0.32

func Find[T tdl.Plugin](plugins iter.Seq[tdl.Plugin], pred Predicate[T]) (res T, found bool)

func FromPath ¶

func FromPath(name string) *fromPath

func Generator ¶ added in v0.0.33

func Generator(
	ctx context.Context,
	plugin tdl.Plugin,
	target tdl.Target,
) (tdl.Generator, error)

func HasKey ¶ added in v0.0.33

func HasKey(plugin tdl.Plugin, key string) bool

func HasMetaValue ¶ added in v0.0.33

func HasMetaValue(plugin tdl.Plugin, key, value string) bool

func MatchesName ¶ added in v0.0.33

func MatchesName(plugin tdl.Plugin, name string) bool

func MetaValue ¶ added in v0.0.33

func MetaValue(plugin tdl.Plugin, key string) (string, bool)

func MetaValues ¶ added in v0.0.33

func MetaValues(plugin tdl.Plugin) iter.Seq2[string, string]

func OfType ¶ added in v0.0.33

func OfType[T tdl.Plugin](seq iter.Seq[tdl.Plugin]) iter.Seq[T]

func ParseToken ¶ added in v0.0.33

func ParseToken(token string) (tdl.Plugin, error)

func ParseUrl ¶ added in v0.0.33

func ParseUrl(url *url.URL) (tdl.Plugin, error)

func Pull ¶ added in v0.0.33

func Pull(ctx context.Context, plugin tdl.Plugin, options ...PullOption) error

func PullToken ¶ added in v0.0.33

func PullToken(ctx context.Context, name string, options ...PullOption) error

func Sorted ¶

func Sorted[O Ordered](seq iter.Seq[O]) []O

func Static ¶ added in v0.0.31

func Static() iter.Seq[tdl.Plugin]

func Subscribe[F progress.Func](plugin tdl.Plugin, handler F) rx.Subscription

func SupportsLang ¶ added in v0.0.33

func SupportsLang(plugin tdl.Plugin, lang string) bool

func Tool ¶ added in v0.0.33

func Tool(
	ctx context.Context,
	plugin tdl.Plugin,
	target tdl.Target,
) (tdl.Tool, error)

func TrySubscribe ¶ added in v0.0.33

func TrySubscribe[F progress.Func](plugin tdl.Plugin, handler F) (rx.Subscription, bool)

func Unwrap ¶

func Unwrap(plugin tdl.Plugin) []tdl.Plugin

func UnwrapAll ¶

func UnwrapAll(plugins []tdl.Plugin) []tdl.Plugin

func UnwrapEach ¶ added in v0.0.33

func UnwrapEach(plugins iter.Seq[tdl.Plugin]) iter.Seq[tdl.Plugin]

Types ¶

type Aggregate ¶

type Aggregate []tdl.Plugin

func NewAggregate ¶

func NewAggregate(plugins ...tdl.Plugin) Aggregate

func (Aggregate) Meta ¶ added in v0.0.33

func (a Aggregate) Meta() tdl.Meta

Meta implements tdl.Plugin.

func (Aggregate) Prepare ¶ added in v0.0.33

func (a Aggregate) Prepare(ctx context.Context) error

Prepare implements tdl.Plugin.

func (Aggregate) String ¶

func (a Aggregate) String() string

String implements tdl.Plugin.

func (Aggregate) Supports ¶ added in v0.0.33

func (a Aggregate) Supports(target tdl.Target) bool

Supports implements tdl.Plugin

type GeneratorPlugin ¶ added in v0.0.33

type GeneratorPlugin interface {
	tdl.Plugin
	Generator(context.Context, tdl.Meta) (tdl.Generator, error)
}

type Observable ¶ added in v0.0.33

type Observable interface {
	tdl.Plugin
	progress.Observable
}

func Observe ¶ added in v0.0.33

func Observe(plugin tdl.Plugin) Observable

func TryObserve ¶ added in v0.0.33

func TryObserve(plugin tdl.Plugin) (Observable, bool)

type Ordered ¶

type Ordered interface {
	tdl.Plugin
	Order() int
}

func AsOrdered ¶

func AsOrdered(plugin tdl.Plugin) Ordered

func WithPriority ¶

func WithPriority(plugin tdl.Plugin, priority int) Ordered

type Predicate ¶ added in v0.0.33

type Predicate[T tdl.Plugin] func(T) bool

type PullOption ¶ added in v0.0.33

type PullOption func(*PullOptions)

func WithProgress ¶ added in v0.0.33

func WithProgress(progress rx.Observer[progress.Event]) PullOption

type PullOptions ¶ added in v0.0.33

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

type ToolPlugin ¶ added in v0.0.33

type ToolPlugin interface {
	tdl.Plugin
	Tool(context.Context, tdl.Meta) (tdl.Tool, error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
docker
github

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func FilterSupported ¶ added in v0.0.33

func Find ¶ added in v0.0.32

func FromPath ¶

func Generator ¶ added in v0.0.33

func HasKey ¶ added in v0.0.33

func HasMetaValue ¶ added in v0.0.33

func MatchesName ¶ added in v0.0.33

func MetaValue ¶ added in v0.0.33

func MetaValues ¶ added in v0.0.33

func OfType ¶ added in v0.0.33

func ParseToken ¶ added in v0.0.33

func ParseUrl ¶ added in v0.0.33

func Pull ¶ added in v0.0.33

func PullToken ¶ added in v0.0.33

func Sorted ¶

func Static ¶ added in v0.0.31

func Subscribe ¶ added in v0.0.33

func SupportsLang ¶ added in v0.0.33

func Tool ¶ added in v0.0.33

func TrySubscribe ¶ added in v0.0.33

func Unwrap ¶

func UnwrapAll ¶

func UnwrapEach ¶ added in v0.0.33

Types ¶

type Aggregate ¶

func NewAggregate ¶

func (Aggregate) Meta ¶ added in v0.0.33

func (Aggregate) Prepare ¶ added in v0.0.33

func (Aggregate) String ¶

func (Aggregate) Supports ¶ added in v0.0.33

type GeneratorPlugin ¶ added in v0.0.33

type Observable ¶ added in v0.0.33

func Observe ¶ added in v0.0.33

func TryObserve ¶ added in v0.0.33

type Ordered ¶

func AsOrdered ¶

func WithPriority ¶

type Predicate ¶ added in v0.0.33

type PullOption ¶ added in v0.0.33

func WithProgress ¶ added in v0.0.33

type PullOptions ¶ added in v0.0.33

type ToolPlugin ¶ added in v0.0.33

Source Files ¶

Directories ¶