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 WithBuildTags(tags ...string) func(p *Packages)
- type Option
- type 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CompatibleTypes ¶
CompatibleTypes isnt a strict comparison, it allows for pointer differences
func ImportPathForDir ¶
ImportPathForDir takes a path and returns a golang import path for the package
func NameForDir ¶ added in v0.9.0
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 ¶
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 ¶
take a string in the form github.com/package/blah.Type and split it into package and type
func QualifyPackagePath ¶
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 WithBuildTags ¶ added in v0.17.37
WithBuildTags adds build tags to the packages.Load call
Types ¶
type Option ¶ added in v0.17.37
type Option func(p *Packages)
Option is a function that can be passed to NewPackages to configure the package loader
type Packages ¶ added in v0.11.0
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 ¶ added in v0.17.37
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 ¶ added in v0.17.29
func (p *Packages) CleanupUserPackages()
func (*Packages) Errors ¶ added in v0.11.0
Errors returns any errors that were returned by Load, either from the call itself or any of the loaded packages.
func (*Packages) Evict ¶ added in v0.11.0
Evict removes a given package import path from the cache, along with any packages that depend on it. Further calls to Load will fetch it from disk.
func (*Packages) Load ¶ added in v0.11.0
Load works the same as LoadAll, except a single package at a time.
func (*Packages) LoadAll ¶ added in v0.11.0
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 ¶ added in v0.11.0
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) NameForPackage ¶ added in v0.11.0
NameForPackage looks up the package name from the package stanza in the go files at the given import path.
Source Files