carthage

Documentation

Index

• func RecurseDeps(pkgMap map[pkg.ID]pkg.Package, p Package)
• type Carthage
  • func (c *Carthage) Install(dir string) error
• type Package
  • func FromResolvedCartfile(projectName string, dir string) (Package, error)
• type Requirement
  • func (r Requirement) Package(dir string) (Package, error)
  • func (r Requirement) String() string

Functions

func RecurseDeps

func RecurseDeps(pkgMap map[pkg.ID]pkg.Package, p Package)

Types

type Carthage

type Carthage struct {
	Bin string
}

func (*Carthage) Install

func (c *Carthage) Install(dir string) error

type Package

type Package struct {
	Name         string // Name of project
	Version      string // Version of project
	Dependencies []Requirement
	Dir          string // directory of cartfile
}

func FromResolvedCartfile

func FromResolvedCartfile(projectName string, dir string) (Package, error)

From the docs: Cartfiles are a restricted subset of the Ordered Graph Data Language, and any standard OGDL tool should be able to parse them. Because of this, we use an OGDL parsing library (rveen/ogdl), which parses a cartfile like so: _

github
	Quick/Nimble
		v7.1.3
github
	facebook/ios-snapshot-test-case
		2.1.4
github
	facebook/yoga
		1.9.0
github
	jspahrsummers/xcconfigs
		0.9

type Requirement

type Requirement struct {
	Origin       string // "github" || "git" || "binary"
	Name         string
	Revision     string // tag/branch/commit
	CheckoutName string // if github repo, i.e. "Quick/Nimble", Name will be "Nimble"
}

func (Requirement) Package

func (r Requirement) Package(dir string) (Package, error)

Attempt to construct a Package from a dep given the parent directory

func (Requirement) String

func (r Requirement) String() string