deps

Documentation

Overview

Package deps provides vendoring for repositories.

Index

• func Hold(m *manifest.Manifest, verbose bool) int
• func Prune(deptree []string, verbose bool) (dirs, files int, pruned []string)
• func Vend(pkgs []string, format string, options ...VendOptions) error
• func Vendorable(verbose bool) error
• type VendOptions
  • func ParseOptions(update, lock, hold, prune, ignore, verbose, tree, results bool) []VendOptions

Functions

func Hold

func Hold(m *manifest.Manifest, verbose bool) int

Hold takes a manifest and downloads all the repos with a hold value of true.

func Prune

func Prune(deptree []string, verbose bool) (dirs, files int, pruned []string)

Prune takes a deptree and verbose option and returns the number of directories and files removed.

func Vend

func Vend(pkgs []string, format string, options ...VendOptions) error

Vend is the main function govend uses to vendor external packages. Vend also invokes the Hold and Prune methods.

func Vendorable

func Vendorable(verbose bool) error

Vendorable ensures the current local setup is conducive to vendoring.

If the current version of Go cannot be parsed, then trust it supports vendoring, but display a message if verbose is true.

Types

type VendOptions

type VendOptions int

VendOptions represents available vend options.

const (
	// UpdateOption updates vendored repositories.
	UpdateOption VendOptions = iota

	// LockOption locks the revision version of vendored repositories.
	LockOption

	// HoldOption holds onto a vendored repository, even if none of its import
	// paths are used in the project source code.
	HoldOption

	// PruneOption removes vendored packages that are not needed.
	PruneOption

	// IgnoreOption ignores the source import paths.
	IgnoreOption

	// VerboseOption prints out packages as they are vendored.
	VerboseOption

	// TreeOption prints the names of packages as an indented tree.
	TreeOption

	// ResultsOption prints a summary of the number of packages scanned, packages
	// skipped, and repositories downloaded.
	ResultsOption
)

func ParseOptions

func ParseOptions(update, lock, hold, prune, ignore, verbose, tree, results bool) []VendOptions

ParseOptions converts cli flag inputs to VendOptions.