packages

Documentation

Overview

Package packages provides Go package traversal in a Bazel repository.

Index

• func Walk(c *config.Config, dir string, f WalkFunc)
• type Package
  • func (p *Package) HasGo() bool
  • func (p *Package) IsCommand() bool
• type PlatformStrings
  • func (ps *PlatformStrings) Clean()
  • func (ts *PlatformStrings) HasGo() bool
  • func (ts *PlatformStrings) IsEmpty() bool
  • func (ps *PlatformStrings) Map(f func(string) (string, error)) (PlatformStrings, []error)
• type Target
  • func (t *Target) HasGo() bool
• type WalkFunc

Functions

func Walk

func Walk(c *config.Config, dir string, f WalkFunc)

Walk walks through directories under "root". It calls back "f" for each package. If an existing BUILD file is present in the directory, it will be parsed and passed to "f" as well.

Walk is similar to "golang.org/x/tools/go/buildutil".ForEachPackage, but it does not assume the standard Go tree because Bazel rules_go uses go_prefix instead of the standard tree.

If a directory contains no buildable Go code, "f" is not called. If a directory contains one package with any name, "f" will be called with that package. If a directory contains multiple packages and one of the package names matches the directory name, "f" will be called on that package and the other packages will be silently ignored. If none of the package names match the directory name, or if some other error occurs, an error will be logged, and "f" will not be called.

Types

type Package

type Package struct {
	// Name is the symbol found in package declarations of the .go files in
	// the package. It does not include the "_test" suffix from external tests.
	Name string

	// Dir is an absolute path to the directory that contains the package.
	Dir string

	// Rel is the relative path to the package directory from the repository
	// root. If the directory is the repository root itself, Rel is empty.
	// Components in Rel are separated with slashes.
	Rel string

	Library, CgoLibrary, Binary, Test, XTest Target

	Protos      []string
	HasPbGo     bool
	HasTestdata bool
}

Package contains metadata about a Go package extracted from a directory. It fills a similar role to go/build.Package, but it separates files by target instead of by type, and it supports multiple platforms.

func (*Package) HasGo

func (p *Package) HasGo() bool

HasGo returns true if at least one target in the package contains a .go source file. If a package does not contain Go code, Gazelle will not generate rules for it.

func (*Package) IsCommand

func (p *Package) IsCommand() bool

IsCommand returns true if the package name is "main".

type PlatformStrings

type PlatformStrings struct {
	// Generic is a list of strings not specific to any platform.
	Generic []string

	// Platform is a map of lists of platform-specific strings. The map is keyed
	// by the name of the platform.
	Platform map[string][]string
}

PlatformStrings contains a set of strings associated with a buildable Go target in a package. This is used to store source file names, import paths, and flags.

func (*PlatformStrings) Clean

func (ps *PlatformStrings) Clean()

Clean sorts and de-duplicates PlatformStrings. It also removes any strings from platform-specific lists that also appear in the generic list. This is useful for imports.

func (*PlatformStrings) HasGo

func (ts *PlatformStrings) HasGo() bool

func (*PlatformStrings) IsEmpty

func (ts *PlatformStrings) IsEmpty() bool

func (*PlatformStrings) Map

func (ps *PlatformStrings) Map(f func(string) (string, error)) (PlatformStrings, []error)

Map applies a function to the strings in "ps" and returns a new PlatformStrings with the results. This is useful for converting import paths to labels.

type Target

type Target struct {
	Sources, Imports PlatformStrings
	COpts, CLinkOpts PlatformStrings
}

Target contains metadata about a buildable Go target in a package.

func (*Target) HasGo

func (t *Target) HasGo() bool

type WalkFunc

type WalkFunc func(pkg *Package, oldFile *bf.File)

A WalkFunc is a callback called by Walk for each package.