plugins

Documentation

Overview

Code generated by "gonum -types=KindEnum -output=kind_enum.go"; DO NOT EDIT. See https://github.com/steinfletcher/gonum

Index

• Variables
• func IsValidKind(k Kind) bool
• func KindNames() []string
• func NewProgress(out io.Writer, size int, description string, opts ...progressbar.Option) (bar *progressbar.ProgressBar)
• func NewQuery(opts ...QueryOption) string
• type Client
  • func NewClient(baseURL *url.URL, httpClient *http.Client) Client
• type Kind
  • func KindValues() []Kind
  • func NewKind(value string) (Kind, error)
  • func ParseKindFromRepo(repo github.Repository) (k Kind, err error)
  • func (g Kind) Description() string
  • func (g Kind) Error() string
  • func (k Kind) IsValid() bool
  • func (g Kind) MarshalJSON() ([]byte, error)
  • func (g Kind) Name() string
  • func (g Kind) String() string
  • func (g *Kind) UnmarshalJSON(b []byte) error
• type KindEnum
• type PluginSearchResult
• type PluginSearchResults
• type Query
  • func (p *Query) String() string
• type QueryOption
  • func WithKind(kind Kind) QueryOption
  • func WithName(name string) QueryOption
• type Store

Variables

var (
	ErrNoValidTopics = errors.New("topics did not contain a valid topic matching 'devctl-<PLUGIN_KIND>-plugin'")
	ErrInvalidTopic  = errors.New("failed to parse string as a plugin kind that is not known")
)

var SDK = Kind{/* contains filtered or unexported fields */}

Enum instances

Functions

func IsValidKind

func IsValidKind(k Kind) bool

func KindNames

func KindNames() []string

KindNames returns the displays values of all enum instances as a slice

func NewProgress

func NewProgress(out io.Writer, size int, description string, opts ...progressbar.Option) (bar *progressbar.ProgressBar)

func NewQuery

func NewQuery(opts ...QueryOption) string

Types

type Client

type Client interface {
	SearchOpts(ctx context.Context, option ...QueryOption) (res PluginSearchResults, err error)
	Search(ctx context.Context, query string) (res PluginSearchResults, err error)
}

func NewClient

func NewClient(baseURL *url.URL, httpClient *http.Client) Client

type Kind

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

Kind is the enum that instances should be created from

func KindValues

func KindValues() []Kind

KindValues returns all enum instances as a slice

func NewKind

func NewKind(value string) (Kind, error)

NewKind generates a new Kind from the given display value (name)

func ParseKindFromRepo

func ParseKindFromRepo(repo github.Repository) (k Kind, err error)

func (Kind) Description

func (g Kind) Description() string

Description returns the enum description if present. If no description is defined an empty string is returned

func (Kind) Error

func (g Kind) Error() string

Error returns the enum name and implements the Error interface

func (Kind) IsValid

func (k Kind) IsValid() bool

func (Kind) MarshalJSON

func (g Kind) MarshalJSON() ([]byte, error)

MarshalJSON provides json serialization support by implementing the Marshaler interface

func (Kind) Name

func (g Kind) Name() string

Name returns the enum display value

func (Kind) String

func (g Kind) String() string

String returns the enum display value and is an alias of Name to implement the Stringer interface

func (*Kind) UnmarshalJSON

func (g *Kind) UnmarshalJSON(b []byte) error

UnmarshalJSON provides json deserialization support by implementing the Unmarshaler interface

type KindEnum

type KindEnum struct {
	SDK string `enum:"SDK,installs updates and manages different sdks on your system"`
}

type PluginSearchResult

type PluginSearchResult struct {
	Name           string
	Uri            string
	RepositoryName string
	Topics         []string
	Kind           Kind
}

type PluginSearchResults

type PluginSearchResults []PluginSearchResult

type Query

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

func (*Query) String

func (p *Query) String() string

type QueryOption

type QueryOption func(query *Query) *Query

func WithKind

func WithKind(kind Kind) QueryOption

func WithName

func WithName(name string) QueryOption

type Store

type Store interface {
	Register(kind Kind, string string) error
	List(kind Kind) (plugins map[string]string, err error)
}