vendorfile

Documentation

Overview

Package vendorfile is the meta-data file for vendoring. Round-trips unknown fields. It will also allow moving the vendor file to new locations.

Index

• Constants
• type File
  • func (vf *File) Marshal(w io.Writer) error
  • func (vf *File) Unmarshal(r io.Reader) error
• type Package
  • func (pkg *Package) PathOrigin() string

Constants

const Name = "vendor.json"

Name of the vendor file.

Types

type File

type File struct {
	RootPath string // Import path of vendor folder

	Comment string

	Ignore string

	Package []*Package
	// contains filtered or unexported fields
}

File is the structure of the vendor file.

func (*File) Marshal

func (vf *File) Marshal(w io.Writer) error

Marshal the vendor file to the specified writer. Retains read fields.

func (*File) Unmarshal

func (vf *File) Unmarshal(r io.Reader) error

Unmarshal the vendor file from the specified reader. Stores internally all fields.

type Package

type Package struct {

	// If delete is set to true the package will not be written to the vendor file.
	Remove bool

	// If new is set to true the package will be treated as a new package to the file.
	Add bool

	// See the vendor spec for definitions.
	Origin       string
	Path         string
	Tree         bool
	Revision     string
	RevisionTime string
	Version      string
	VersionExact string
	ChecksumSHA1 string
	Comment      string
	// contains filtered or unexported fields
}

Package represents each package.

func (*Package) PathOrigin

func (pkg *Package) PathOrigin() string