module

type Analyzed struct {
	Module       Module
	Builder      Builder
	Dependencies []Dependency
}

type Builder interface {
	// Initialize gathers build environment information and does build setup.
	Initialize() error
	// Build runs a best-effort attempt at building the module.
	Build(m Module, force bool) error
	// Analyze returns the dependencies of a module.
	Analyze(m Module, allowUnresolved bool) ([]Dependency, error)

	// IsBuilt checks whether a module has been built.
	IsBuilt(m Module, allowUnresolved bool) (bool, error)

	// IsModule takes a string module type and returns whether it matches to use this Builder.
	IsModule(key string) (bool, error)
	// DiscoverModules finds what modules are available for analysis in a given directory.
	DiscoverModules(dir string) ([]Config, error)
}

type Config struct {
	Name    string  `yaml:"name"`
	Path    string  `yaml:"path"` // this should really be renamed to Target (for e.g. Golang with gopaths or .NET or Maven with manifest files)
	Type    string  `yaml:"type"`
	Options Options `yaml:"options"`
}

type Dependency struct {
	Locator

	Via []ImportPath
}

type GoOptions struct {
	AllowUnresolved bool
}

type GradleOptions struct {
	Task          string
	Configuration string
}

type ImportPath []Locator

type ImportPathString string

type Locator struct {
	Fetcher  string `json:"fetcher"`
	Project  string `json:"package"`
	Revision string `json:"revision"`
}

type MavenOptions struct {
	Settings string
}

type Module struct {
	Name string
	Type Type

	// Target is the entry point or manifest path for the build system. The exact
	// meaning is Type-dependent.
	Target string
	// Dir is the absolute path to the module's working directory (the directory
	// you would normally run the build command from).
	Dir string

	// Different modules in a monolith may correspond to different FOSSA projects
	// or revisions.
	// TODO: use these values.
	Project  string
	Revision string

	// A catch-all for builders to add metadata (a la Context.Value).
	Context interface{}
}

type NuGetOptions struct {
	TargetFramework string
}

type Options struct {
	Go     GoOptions
	Python PythonOptions
	Gradle GradleOptions
	Maven  MavenOptions
	NuGet  NuGetOptions
}

type PythonOptions struct {
	Strategy string
}

type Type string