code

Documentation

Index

• func CompatibleTypes(expected, actual types.Type) error
• func ImportPathForDir(dir string) (res string)
• func NameForDir(dir string) string
• func NormalizeVendor(pkg string) string
• func PkgAndType(name string) (string, string)
• func QualifyPackagePath(importPath string) string
• func SanitizePackageName(pkg string) string
• func Unalias(t types.Type) types.Type
• func WithBuildTags(tags ...string) func(p *Packages)
• type Option
• type Packages
  • func NewPackages(opts ...Option) *Packages
  • func (p *Packages) CleanupUserPackages()
  • func (p *Packages) Count() int
  • func (p *Packages) Errors() PkgErrors
  • func (p *Packages) Evict(importPath string)
  • func (p *Packages) Load(importPath string) *packages.Package
  • func (p *Packages) LoadAll(importPaths ...string) []*packages.Package
  • func (p *Packages) LoadWithTypes(importPath string) *packages.Package
  • func (p *Packages) ModTidy() error
  • func (p *Packages) NameForPackage(importPath string) string
  • func (p *Packages) ReloadAll(importPaths ...string) []*packages.Package
• type PkgErrors
  • func (p PkgErrors) Error() string

Functions

func CompatibleTypes

func CompatibleTypes(expected, actual types.Type) error

CompatibleTypes isnt a strict comparison, it allows for pointer differences

func ImportPathForDir

func ImportPathForDir(dir string) (res string)

ImportPathForDir takes a path and returns a golang import path for the package

func NameForDir

func NameForDir(dir string) string

NameForDir manually looks for package stanzas in files located in the given directory. This can be much faster than having to consult go list, because we already know exactly where to look.

func NormalizeVendor

func NormalizeVendor(pkg string) string

NormalizeVendor takes a qualified package path and turns it into normal one. eg . github.com/foo/vendor/github.com/99designs/gqlgen/graphql becomes github.com/99designs/gqlgen/graphql

func PkgAndType

func PkgAndType(name string) (string, string)

take a string in the form github.com/package/blah.Type and split it into package and type

func QualifyPackagePath

func QualifyPackagePath(importPath string) string

QualifyPackagePath takes an import and fully qualifies it with a vendor dir, if one is required. eg . github.com/99designs/gqlgen/graphql becomes github.com/foo/vendor/github.com/99designs/gqlgen/graphql

x/tools/packages only supports 'qualified package paths' so this will need to be done prior to calling it See https://github.com/golang/go/issues/30289

func SanitizePackageName

func SanitizePackageName(pkg string) string

func Unalias

func Unalias(t types.Type) types.Type

Unalias unwraps an alias type

func WithBuildTags

func WithBuildTags(tags ...string) func(p *Packages)

WithBuildTags adds build tags to the packages.Load call

Types

type Option

type Option func(p *Packages)

Option is a function that can be passed to NewPackages to configure the package loader

type Packages

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

Packages is a wrapper around x/tools/go/packages that maintains a (hopefully prewarmed) cache of packages that can be invalidated as writes are made and packages are known to change.

func NewPackages

func NewPackages(opts ...Option) *Packages

NewPackages creates a new packages cache It will load all packages in the current module, and any packages that are passed to Load or LoadAll

func (*Packages) CleanupUserPackages

func (p *Packages) CleanupUserPackages()

func (*Packages) Count

func (p *Packages) Count() int

func (*Packages) Errors

func (p *Packages) Errors() PkgErrors

Errors returns any errors that were returned by Load, either from the call itself or any of the loaded packages.

func (*Packages) Evict

func (p *Packages) Evict(importPath string)

Evict removes a given package import path from the cache. Further calls to Load will fetch it from disk.

func (*Packages) Load

func (p *Packages) Load(importPath string) *packages.Package

Load works the same as LoadAll, except a single package at a time.

func (*Packages) LoadAll

func (p *Packages) LoadAll(importPaths ...string) []*packages.Package

LoadAll will call packages.Load and return the package data for the given packages, but if the package already have been loaded it will return cached values instead.

func (*Packages) LoadWithTypes

func (p *Packages) LoadWithTypes(importPath string) *packages.Package

LoadWithTypes tries a standard load, which may not have enough type info (TypesInfo== nil) available if the imported package is a second order dependency. Fortunately this doesnt happen very often, so we can just issue a load when we detect it.

func (*Packages) ModTidy

func (p *Packages) ModTidy() error

func (*Packages) NameForPackage

func (p *Packages) NameForPackage(importPath string) string

NameForPackage looks up the package name from the package stanza in the go files at the given import path.

func (*Packages) ReloadAll

func (p *Packages) ReloadAll(importPaths ...string) []*packages.Package

ReloadAll will call LoadAll after clearing the package cache, so we can reload packages in the case that the packages have changed

type PkgErrors

type PkgErrors []error

func (PkgErrors) Error

func (p PkgErrors) Error() string