resolve

Documentation

Index

• Variables
• func ImportPathToBazelRepoName(importpath string) string
• func IsStandard(imp string) bool
• type Label
  • func ParseLabel(s string) (Label, error)
  • func (l Label) Abs(repo, pkg string) Label
  • func (l Label) String() string
• type Labeler
  • func NewLabeler(c *config.Config) Labeler
• type Resolver
  • func NewResolver(c *config.Config, l Labeler) *Resolver
  • func (r *Resolver) ResolveRule(e bf.Expr, pkgRel, buildRel string)
• type RuleIndex
  • func NewRuleIndex() *RuleIndex
  • func (ix *RuleIndex) AddGeneratedRules(c *config.Config, buildRel string, rules []bf.Expr)
  • func (ix *RuleIndex) AddRulesFromFile(c *config.Config, oldFile *bf.File)
  • func (ix *RuleIndex) Finish()

Variables

var NoLabel = Label{}

NoLabel is the nil value of Label. It is not a valid label and may be returned when an error occurs.

Functions

func ImportPathToBazelRepoName

func ImportPathToBazelRepoName(importpath string) string

ImportPathToBazelRepoName converts a Go import path into a bazel repo name following the guidelines in http://bazel.io/docs/be/functions.html#workspace

func IsStandard

func IsStandard(imp string) bool

IsStandard returns whether a package is in the standard library.

Types

type Label

type Label struct {
	Repo, Pkg, Name string
	Relative        bool
}

A Label represents a label of a build target in Bazel.

func ParseLabel

func ParseLabel(s string) (Label, error)

ParseLabel reads a label from a string. See https://docs.bazel.build/versions/master/build-ref.html#lexi.

func (Label) Abs

func (l Label) Abs(repo, pkg string) Label

func (Label) String

func (l Label) String() string

type Labeler

type Labeler interface {
	LibraryLabel(rel string) Label
	TestLabel(rel string, isXTest bool) Label
	BinaryLabel(rel string) Label
	ProtoLabel(rel, name string) Label
	GoProtoLabel(rel, name string) Label
}

Labeler generates Bazel labels for rules, based on their locations within the repository.

func NewLabeler

func NewLabeler(c *config.Config) Labeler

type Resolver

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

Resolver resolves import strings in source files (import paths in Go, import statements in protos) into Bazel labels. TODO(#859): imports are currently resolved by guessing a label based on the name. We should be smarter about this and build a table mapping import paths to labels that we can use to cross-reference.

func NewResolver

func NewResolver(c *config.Config, l Labeler) *Resolver

func (*Resolver) ResolveRule

func (r *Resolver) ResolveRule(e bf.Expr, pkgRel, buildRel string)

ResolveRule modifies a generated rule e by replacing the import paths in the "_gazelle_imports" attribute with labels in a "deps" attribute. This may may safely called on expressions that aren't Go rules (nothing will happen).

type RuleIndex

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

RuleIndex is a table of rules in a workspace, indexed by label and by import path. Used by Resolver to map import paths to labels.

func NewRuleIndex

func NewRuleIndex() *RuleIndex

func (*RuleIndex) AddGeneratedRules

func (ix *RuleIndex) AddGeneratedRules(c *config.Config, buildRel string, rules []bf.Expr)

AddGeneratedRules adds newly generated rules to the index. These may replace existing rules with the same label.

func (*RuleIndex) AddRulesFromFile

func (ix *RuleIndex) AddRulesFromFile(c *config.Config, oldFile *bf.File)

AddRulesFromFile adds existing rules to the index from oldFile (which must not be nil).

func (*RuleIndex) Finish

func (ix *RuleIndex) Finish()

Finish constructs the import index and performs any other necessary indexing actions after all rules have been added. This step is necessary because a rule may be indexed differently based on what rules are added later.

This function must be called after all AddRulesFromFile and AddGeneratedRules calls but before any findRuleByImport calls.