kdep

Documentation

Index

• Variables
• type Ctx
  • func (c *Ctx) LoadProject() (*Project, error)
• type Manifest
  • func WrapManifest(m *dep.Manifest) *Manifest
  • func (m *Manifest) DependencyConstraints() gps.ProjectConstraints
  • func (m *Manifest) IgnoredPackages() *pkgtree.IgnoredRuleset
  • func (m *Manifest) Overrides() gps.ProjectConstraints
  • func (m *Manifest) RequiredPackages() map[string]bool
• type Metadata
• type Project
  • func WrapProject(p *dep.Project, c *Ctx) (*Project, error)
  • func (p *Project) HackExtraVendorEntries() error
  • func (p *Project) HackGodepsCompat(s gps.Solution) error
  • func (p *Project) MakeParams() gps.SolveParameters
  • func (p *Project) ParseRootPackageTree() (pkgtree.PackageTree, error)

Variables

var (
	// FallbackToDep makes kdep behave like dep. This is solely to reuse dep
	// tests.
	FallbackToDep = false
)

Types

type Ctx

type Ctx struct {
	*dep.Ctx
}

Ctx wraps dep.Ctx to support kdep projects

func (*Ctx) LoadProject

func (c *Ctx) LoadProject() (*Project, error)

LoadProject finds the first dep project with a kdep-project flag

type Manifest

type Manifest struct {
	*dep.Manifest
	Meta         *Metadata
	SubManifests map[string]*dep.Manifest
	ImportRoot   string
	Dependencies []string
}

Manifest wraps dep.Manifest to support kdep projects

func WrapManifest

func WrapManifest(m *dep.Manifest) *Manifest

WrapManifest generates a kdep Manifest

func (*Manifest) DependencyConstraints

func (m *Manifest) DependencyConstraints() gps.ProjectConstraints

DependencyConstraints computes the aggregate set of dependency constraints for a kdep project

func (*Manifest) IgnoredPackages

func (m *Manifest) IgnoredPackages() *pkgtree.IgnoredRuleset

IgnoredPackages computes the aggregate set of ignored packages for a kdep project

func (*Manifest) Overrides

func (m *Manifest) Overrides() gps.ProjectConstraints

Overrides computes the aggregate set of overrides for a kdep project

func (*Manifest) RequiredPackages

func (m *Manifest) RequiredPackages() map[string]bool

RequiredPackages computes the aggregate set of required packages for a kdep project

type Metadata

type Metadata struct {
	IsKdepRoot          bool     `toml:"kdep-project,omitempty"`
	IsKdepChild         bool     `toml:"kdep-child,omitempty"`
	GodepCompat         bool     `toml:"kdep-godep-compat,omitempty"`
	LocalGopaths        []string `toml:"kdep-local-gopaths"`
	LocalDeps           []string `toml:"kdep-local-deps"`
	UninterestingTags   []string `toml:"kdep-uninteresting-tags"`
	BlackListedPackages []string `toml:"kdep-blacklisted-packages"`
}

Metadata holds kdep metadata information

type Project

type Project struct {
	*dep.Project
	Manifest    *Manifest
	SubProjects []*dep.Project
	// contains filtered or unexported fields
}

Project wraps dep.Project to support kdep projects

func WrapProject

func WrapProject(p *dep.Project, c *Ctx) (*Project, error)

WrapProject wraps a dep.Project in a kdep.Project

func (*Project) HackExtraVendorEntries

func (p *Project) HackExtraVendorEntries() error

HackExtraVendorEntries generates extra vendor entries for local packages

func (*Project) HackGodepsCompat

func (p *Project) HackGodepsCompat(s gps.Solution) error

HackGodepsCompat generates a godep-like manifest for compatibility

func (*Project) MakeParams

func (p *Project) MakeParams() gps.SolveParameters

MakeParams generates resolution parameters

func (*Project) ParseRootPackageTree

func (p *Project) ParseRootPackageTree() (pkgtree.PackageTree, error)

ParseRootPackageTree generates the pkgtree.PackageTree for a kdep multi-repo