enrichers

Documentation

Index

• Constants
• func NewEntityIdEnricher() entityIdEnricher
• func NewEntityNameEnricher() entityNameEnricher
• func NewHooksListEnricher() hooksListEnricher
• func NewMembersListEnricher() membersListEnricher
• func NewOrganizationIdEnricher() organizationIdEnricher
• type BasicEnrichment
  • func NewBasicEnrichment(val string) BasicEnrichment
  • func NewBasicEnrichmentFromInterface(data interface{}) (BasicEnrichment, error)
  • func (s BasicEnrichment) HumanReadable(_ string, _ string) string
• type Enricher
  • func NewScorecardEnricher() Enricher
• type Enrichment
• type GenericListEnrichment
  • func NewGenericListEnrichmentFromInterface(data interface{}) (GenericListEnrichment, error)
  • func (se GenericListEnrichment) HumanReadable(prepend string, linebreak string) string
• type MembersListEnrichment
  • func (se MembersListEnrichment) HumanReadable(prepend string, linebreak string) string
• type ScorecardCheck
• type ScorecardEnrichment
  • func (se ScorecardEnrichment) HumanReadable(prepend string, linebreak string) string

Constants

const EntityId = "entityId"

const EntityName = "entityName"

const HooksList = "hooksList"

const MembersList = "violatedUsers"

const OrganizationId = "organizationId"

const Scorecard = "scorecard"

Functions

func NewEntityIdEnricher

func NewEntityIdEnricher() entityIdEnricher

func NewEntityNameEnricher

func NewEntityNameEnricher() entityNameEnricher

func NewHooksListEnricher

func NewHooksListEnricher() hooksListEnricher

func NewMembersListEnricher

func NewMembersListEnricher() membersListEnricher

func NewOrganizationIdEnricher

func NewOrganizationIdEnricher() organizationIdEnricher

Types

type BasicEnrichment

type BasicEnrichment string

func NewBasicEnrichment

func NewBasicEnrichment(val string) BasicEnrichment

func NewBasicEnrichmentFromInterface

func NewBasicEnrichmentFromInterface(data interface{}) (BasicEnrichment, error)

func (BasicEnrichment) HumanReadable

func (s BasicEnrichment) HumanReadable(_ string, _ string) string

type Enricher

type Enricher interface {
	Enrich(ctx context.Context, data analyzers.AnalyzedData) (enrichment Enrichment, ok bool)
	Parse(data interface{}) (enrichment Enrichment, err error)
}

func NewScorecardEnricher

func NewScorecardEnricher() Enricher

type Enrichment

type Enrichment interface {
	HumanReadable(prepend string, linebreak string) string
}

type GenericListEnrichment

type GenericListEnrichment []orderedmap.OrderedMap

func NewGenericListEnrichmentFromInterface

func NewGenericListEnrichmentFromInterface(data interface{}) (GenericListEnrichment, error)

func (GenericListEnrichment) HumanReadable

func (se GenericListEnrichment) HumanReadable(prepend string, linebreak string) string

type MembersListEnrichment

type MembersListEnrichment []githubcollected.OrganizationMember

func (MembersListEnrichment) HumanReadable

func (se MembersListEnrichment) HumanReadable(prepend string, linebreak string) string

type ScorecardCheck

type ScorecardCheck struct {
	Reason  string
	DocsUrl string
	Details []string
}

type ScorecardEnrichment

type ScorecardEnrichment []ScorecardCheck

func (ScorecardEnrichment) HumanReadable

func (se ScorecardEnrichment) HumanReadable(prepend string, linebreak string) string