context

Documentation

Overview

Package context gathers the status of packages and stores it in Context. A new Context needs to be pointed to the root of the project and any project owned vendor file.

Index

• Constants
• Variables
• func RemovePackage(path, root string, tree bool) error
• type Conflict
  • func ResolveAutoLongestPath(cc []*Conflict) []*Conflict
  • func ResolveAutoShortestPath(cc []*Conflict) []*Conflict
• type Context
  • func NewContext(root, vendorFilePathRel, vendorFolder string, rewriteImports bool) (*Context, error)
  • func NewContextWD(rt RootType) (*Context, error)
  • func (ctx *Context) Alter() error
  • func (ctx *Context) Check() []*Conflict
  • func (ctx *Context) CopyPackage(destPath, srcPath string, ignoreFiles []string, tree bool, gopath string) error
  • func (ctx *Context) IgnoreBuild(ignore string)
  • func (ctx *Context) ModifyImport(sourcePath string, mod Modify) error
  • func (ctx *Context) ResloveApply(cc []*Conflict)
  • func (ctx *Context) ResolveAutoVendorFileOrigin(cc []*Conflict) []*Conflict
  • func (ctx *Context) Status() ([]StatusItem, error)
  • func (ctx *Context) VendorFilePackageLocal(local string) *vendorfile.Package
  • func (ctx *Context) VendorFilePackagePath(canonical string) *vendorfile.Package
  • func (ctx *Context) WriteVendorFile() (err error)
• type ErrDirtyPackage
  • func (err ErrDirtyPackage) Error() string
• type ErrMissingVendorFile
  • func (err ErrMissingVendorFile) Error() string
• type ErrNotInGOPATH
  • func (err ErrNotInGOPATH) Error() string
• type ErrOldVersion
  • func (err ErrOldVersion) Error() string
• type ErrPackageExists
  • func (err ErrPackageExists) Error() string
• type ErrTreeChildren
  • func (err ErrTreeChildren) Error() string
• type ErrTreeParents
  • func (err ErrTreeParents) Error() string
• type File
• type Modify
• type Operation
• type OperationState
• type Package
• type RootType
• type Status
  • func (pkgSt Status) Match(filterSt Status) bool
  • func (status Status) MatchGroup(filter StatusGroup) bool
  • func (s Status) String() string
• type StatusGroup
  • func (sg StatusGroup) String() string
• type StatusItem
  • func (li StatusItem) String() string
• type StatusLocation
• type StatusPresence
• type StatusType

Constants

const (
	TreeSuffix = "/^"
)

Variables

var (
	// ErrMissingGOROOT returns if the GOROOT was not found.
	ErrMissingGOROOT = errors.New("Unable to determine GOROOT.")
	// ErrMissingGOPATH returns if no GOPATH was found.
	ErrMissingGOPATH = errors.New("Missing GOPATH. Check your environment variable GOPATH.")
)

Functions

func RemovePackage

func RemovePackage(path, root string, tree bool) error

RemovePackage removes the specified folder files. If folder is empty when done (no nested folders, remove the folder and any empty parent folders.

Types

type Conflict

type Conflict struct {
	Canonical string
	Local     string
	Operation []*Operation
	OpIndex   int
	Resolved  bool
}

Conflict reports packages that are scheduled to conflict.

func ResolveAutoLongestPath

func ResolveAutoLongestPath(cc []*Conflict) []*Conflict

ResolveAutoLongestPath finds the longest local path in each conflict and set it to be used.

func ResolveAutoShortestPath

func ResolveAutoShortestPath(cc []*Conflict) []*Conflict

ResolveAutoShortestPath finds the shortest local path in each conflict and set it to be used.

type Context

type Context struct {
	GopathList []string // List of GOPATHs in environment. Includes "src" dir.
	Goroot     string   // The path to the standard library.

	RootDir        string // Full path to the project root.
	RootGopath     string // The GOPATH the project is in.
	RootImportPath string // The import path to the project.

	VendorFile         *vendorfile.File
	VendorFilePath     string // File path to vendor file.
	VendorFolder       string // Store vendor packages in this folder.
	VendorFileToFolder string // The relative path from the vendor file to the vendor folder.
	RootToVendorFile   string // The relative path from the project root to the vendor file directory.

	VendorDiscoverFolder string // Normally auto-set to "vendor"

	// Package is a map where the import path is the key.
	// Populated with LoadPackage.
	Package map[string]*Package

	// MoveRule provides the translation from origional import path to new import path.
	RewriteRule map[string]string // map[from]to

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

Context represents the current project context.

func NewContext

func NewContext(root, vendorFilePathRel, vendorFolder string, rewriteImports bool) (*Context, error)

NewContext creates new context from a given root folder and vendor file path. The vendorFolder is where vendor packages should be placed.

func NewContextWD

func NewContextWD(rt RootType) (*Context, error)

NewContextWD creates a new context. It looks for a root folder by finding a vendor file.

func (*Context) Alter

func (ctx *Context) Alter() error

Alter runs any requested package alterations.

func (*Context) Check

func (ctx *Context) Check() []*Conflict

Check returns any conflicts when more then one package can be moved into the same path.

func (*Context) CopyPackage

func (ctx *Context) CopyPackage(destPath, srcPath string, ignoreFiles []string, tree bool, gopath string) error

CopyPackage copies the files from the srcPath to the destPath, destPath folder and parents are are created if they don't already exist.

func (*Context) IgnoreBuild

func (ctx *Context) IgnoreBuild(ignore string)

IgnoreBuild takes a space separated list of tags to ignore. "a b c" will ignore "a" OR "b" OR "c".

func (*Context) ModifyImport

func (ctx *Context) ModifyImport(sourcePath string, mod Modify) error

AddImport adds the package to the context. The vendorFolder is where the package should be added to relative to the project root.

func (*Context) ResloveApply

func (ctx *Context) ResloveApply(cc []*Conflict)

ResolveApply applies the conflict resolution selected. It chooses the Operation listed in the OpIndex field.

func (*Context) ResolveAutoVendorFileOrigin

func (ctx *Context) ResolveAutoVendorFileOrigin(cc []*Conflict) []*Conflict

ResolveAutoVendorFileOrigin resolves conflicts based on the vendor file if possible.

func (*Context) Status

func (ctx *Context) Status() ([]StatusItem, error)

Status obtains the current package status list.

func (*Context) VendorFilePackageLocal

func (ctx *Context) VendorFilePackageLocal(local string) *vendorfile.Package

VendorFilePackageLocal finds a given vendor file package give the local import path.

func (*Context) VendorFilePackagePath

func (ctx *Context) VendorFilePackagePath(canonical string) *vendorfile.Package

VendorFilePackageCanonical finds a given vendor file package give the canonical import path.

func (*Context) WriteVendorFile

func (ctx *Context) WriteVendorFile() (err error)

WriteVendorFile writes the current vendor file to the context location.

type ErrDirtyPackage

type ErrDirtyPackage struct {
	ImportPath string
}

ErrDirtyPackage returns if package is in dirty version control.

func (ErrDirtyPackage) Error

func (err ErrDirtyPackage) Error() string

type ErrMissingVendorFile

type ErrMissingVendorFile struct {
	Path string
}

ErrMissingVendorFile returns if package already exists.

func (ErrMissingVendorFile) Error

func (err ErrMissingVendorFile) Error() string

type ErrNotInGOPATH

type ErrNotInGOPATH struct {
	Missing string
}

ErrNotInGOPATH returns if not currently in the GOPATH.

func (ErrNotInGOPATH) Error

func (err ErrNotInGOPATH) Error() string

type ErrOldVersion

type ErrOldVersion struct {
	Message string
}

ErrOldVersion returns if vendor file is not in the vendor folder.

func (ErrOldVersion) Error

func (err ErrOldVersion) Error() string

type ErrPackageExists

type ErrPackageExists struct {
	Package string
}

ErrPackageExists returns if package already exists.

func (ErrPackageExists) Error

func (err ErrPackageExists) Error() string

type ErrTreeChildren

type ErrTreeChildren struct {
	// contains filtered or unexported fields
}

func (ErrTreeChildren) Error

func (err ErrTreeChildren) Error() string

type ErrTreeParents

type ErrTreeParents struct {
	// contains filtered or unexported fields
}

func (ErrTreeParents) Error

func (err ErrTreeParents) Error() string

type File

type File struct {
	Package *Package
	Path    string
	Imports []string

	ImportComment string
}

File holds a reference to the imports in a file and the file locaiton.

type Modify

type Modify byte

Modify is the type of modifcation to do.

const (
	AddUpdate Modify = iota // Add or update the import.
	Add                     // Only add, error if it already exists.
	Update                  // Only update, error if it doesn't currently exist.
	Remove                  // Remove from vendor path.
	Fetch                   // Get directly from remote repository.
)

type Operation

type Operation struct {
	Pkg *Package

	// Source file path to move packages from.
	// Must not be empty.
	Src string

	// Destination file path to move package to.
	// If Dest if empty the package is removed.
	Dest string

	// Files to ignore for operation.
	IgnoreFile []string

	State OperationState
}

Operation defines how packages should be moved.

type OperationState

type OperationState byte

OperationState is the state of the given package move operation.

const (
	OpReady  OperationState = iota // Operation is ready to go.
	OpIgnore                       // Operation should be ignored.
	OpDone                         // Operation has been completed.
)

type Package

type Package struct {
	OriginDir  string
	Dir        string
	Canonical  string
	Local      string
	SourcePath string
	Gopath     string // Inlcudes trailing "src".
	Files      []*File
	Status     Status
	Tree       bool
	// contains filtered or unexported fields
}

Package maintains information pertaining to a package.

type RootType

type RootType byte

const (
	RootVendor RootType = iota
	RootWD
	RootVendorOrWD
)

type Status

type Status struct {
	Type     StatusType     // program, package
	Location StatusLocation // vendor, local, external, stdlib
	Presence StatusPresence // missing, unused, tree

	Not bool // Not indicates boolean operation "not" on above.
}

Status is the package type, location, and presence indicators.

func (Status) Match

func (pkgSt Status) Match(filterSt Status) bool

func (Status) MatchGroup

func (status Status) MatchGroup(filter StatusGroup) bool

func (Status) String

func (s Status) String() string

type StatusGroup

type StatusGroup struct {
	Status []Status
	Group  []StatusGroup
	And    bool
	Not    bool
}

StatusGroup is the logical filter for status with "and", "not", and grouping.

func (StatusGroup) String

func (sg StatusGroup) String() string

type StatusItem

type StatusItem struct {
	Status     Status
	Canonical  string
	Local      string
	ImportedBy []string
}

ListItem represents a package in the current project.

func (StatusItem) String

func (li StatusItem) String() string

type StatusLocation

type StatusLocation byte // StatusLocation is where the package is.

const (
	LocationUnknown  StatusLocation = iota // LocationUnknown is unset StatusLocation.
	LocationNotFound                       // LocationNotFound package is not to be found (use PresenceMissing).
	LocationStandard                       // LocationStandard package is in the standard library.
	LocationLocal                          // LocationLocal package is in a project, not in a vendor folder.
	LocationExternal                       // LocationExternal package is not in a project, in GOPATH.
	LocationVendor                         // LocationVendor package is in a vendor folder.
)

type StatusPresence

type StatusPresence byte // StatusPresence is if it can be found or referenced.

const (
	PresenceUnknown StatusPresence = iota // PresenceUnknown is unset StatusPresence.
	PresenceFound                         // PresenceFound package exists.
	PresenceMissing                       // PresenceMissing package is referenced but not found.
	PresenceUnsued                        // PresenceUnused package is found locally but not referenced.
	PresenceTree                          // PresenceTree package is in vendor folder, in a tree, but not referenced.
)

type StatusType

type StatusType byte // StatusType is main or not-main.

const (
	TypeUnknown StatusType = iota // TypeUnknown is unset StatusType.
	TypePackage                   // TypePackage package is a non-main package.
	TypeProgram                   // TypeProgram package is a main package.
)