source

Documentation

Index

• func CanonicalStrings() []string
• type Canonical
  • func CanonicalString(s string) (Canonical, error)
  • func CanonicalValues() []Canonical
  • func (i Canonical) IsACanonical() bool
  • func (i Canonical) String() string
• type Repository
• type Source
  • func (s *Source) BuildID()

Functions

func CanonicalStrings

func CanonicalStrings() []string

CanonicalStrings returns a slice of all String values of the enum

Types

type Canonical

type Canonical int

Canonical it's the type that defines the different Sources supported

const (
	Github Canonical = iota
	Gitlab
	Trello
	Zeplin
)

List of all the supported Sources

func CanonicalString

func CanonicalString(s string) (Canonical, error)

CanonicalString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func CanonicalValues

func CanonicalValues() []Canonical

CanonicalValues returns all values of the enum

func (Canonical) IsACanonical

func (i Canonical) IsACanonical() bool

IsACanonical returns "true" if the value is listed in the enum definition. "false" otherwise

func (Canonical) String

func (i Canonical) String() string

type Repository

type Repository interface {
	// Filter returns a list of Source without
	// any filter
	Filter(ctx context.Context) ([]Source, error)
}

Repository it's the interface for dealing with the Source entity

type Source

type Source struct {
	ID        string
	Name      string
	Canonical Canonical
}

Source it's the basic entity representing the Source configured

func (*Source) BuildID

func (s *Source) BuildID()

BuildID builds the ID of the Source by concatenating the 'Canonical' with the 'Name' with a '-'