module

Documentation

Index

• type Dependency
• type Locator
  • func MakeLocator(d Dependency) Locator
• type Module
  • func New(moduleType config.ModuleType, conf config.ModuleConfig) (Module, error)

Types

type Dependency

type Dependency interface {
	// Locator fields
	Fetcher() string
	Package() string
	Revision() string
}

Dependency represents a code library brought in by running a Build

type Locator

type Locator string

Locator is a string specifying a particular dependency and revision

func MakeLocator

func MakeLocator(d Dependency) Locator

MakeLocator transforms Dependencies into locator strings

type Module

type Module struct {
	Name string
	Type config.ModuleType
	// 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
}

A Module is a unit of buildable code within a project.

func New

func New(moduleType config.ModuleType, conf config.ModuleConfig) (Module, error)

New instantiates and sets up a Module for a given ModuleType