rules

Documentation

Overview

Package rules provides Bazel rule generation for Go build targets.

Index

• func SortLabels(f *bf.File)
• type Generator
  • func NewGenerator(c *config.Config, r *resolve.Resolver, l resolve.Labeler, buildRel string, ...) *Generator
  • func (g *Generator) GenerateRules(pkg *packages.Package) (rules []bf.Expr, empty []bf.Expr)

Functions

func SortLabels

func SortLabels(f *bf.File)

SortLabels sorts lists of strings in "srcs" and "deps" attributes of Go rules using the same order as buildifier. Buildifier also sorts string lists, but not those involved with "select" expressions. TODO(jayconrod): remove this when bazelbuild/buildtools#122 is fixed.

Types

type Generator

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

Generator generates Bazel build rules for Go build targets.

func NewGenerator

func NewGenerator(c *config.Config, r *resolve.Resolver, l resolve.Labeler, buildRel string, oldFile *bf.File) *Generator

NewGenerator returns a new instance of Generator. "buildRel" is a slash-separated path to the directory containing the build file being generated, relative to the repository root. "oldFile" is the existing build file. May be nil.

func (*Generator) GenerateRules

func (g *Generator) GenerateRules(pkg *packages.Package) (rules []bf.Expr, empty []bf.Expr)

GenerateRules generates a list of rules for targets in "pkg". It also returns a list of empty rules that may be deleted from an existing file.