core

Documentation

Index

• type ArchiveContains
• type Args
• type Configuration
  • func LoadConfig(data string) (*Configuration, error)
• type DefinedConfiguration
• type DefinedHandler
• type DefinedRuleSet
• type FileTypes
• type Handler
• type RuleSet

Types

type ArchiveContains

type ArchiveContains []string

ArchiveContains Defines which files should be found in the archive

type Args

type Args []string

Args Defines additional arguments for the executed binary

type Configuration

type Configuration struct {
	Version    string
	Directory  string
	Ecosystems []*Handler
}

Configuration Contains runtime configuration

func LoadConfig

func LoadConfig(data string) (*Configuration, error)

LoadConfig Load runtime configuration from contents of input (YAML) data file

type DefinedConfiguration

type DefinedConfiguration struct {
	Version    string
	Directory  string
	Ecosystems []DefinedHandler
}

DefinedConfiguration Configuration description as defined by the YAML

type DefinedHandler

type DefinedHandler struct {
	Name         string
	Description  string
	Binary       string
	Args         Args
	Handler      string
	Types        FileTypes
	InArchive    ArchiveContains
	FilePatterns DefinedRuleSet
	PathPatterns DefinedRuleSet
	Lockfile     DefinedRuleSet
}

DefinedHandler Handler description as defined by the YAML

type DefinedRuleSet

type DefinedRuleSet []string

DefinedRuleSet Rules as read from the YAML

type FileTypes

type FileTypes []string

FileTypes Trigger on filetypes and if archive contains certain file

type Handler

type Handler struct {
	Name             string
	Description      string
	Binary           string
	Args             Args
	Handler          string
	Types            FileTypes
	InArchive        ArchiveContains
	FilePatterns     RuleSet
	PathPatterns     RuleSet
	LockfilePatterns RuleSet
}

Handler with file/path rules loaded

type RuleSet

type RuleSet []*regexp.Regexp

RuleSet Rules represented by Regexp