generator

Documentation

Overview

Package generator provides core functionality of BUILD file generation in gazelle.

Index

• Variables
• type Generator
  • func New(repoRoot, goPrefix, buildFileName, buildTags string, ...) (*Generator, error)
  • func (g *Generator) Generate(dir string) ([]*bzl.File, error)

Variables

var (
	// GoRulesBzl is the label of the Skylark file which provides Go rules
	// You usually don't need to overwrite this variable.
	//
	// See also #135.
	// TODO(yugui): Make it a constant when we drop support of Bazel 0.3.2.
	GoRulesBzl = "@io_bazel_rules_go//go:def.bzl"
)

Types

type Generator

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

Generator generates BUILD files for a Go repository.

func New

func New(repoRoot, goPrefix, buildFileName, buildTags string, external rules.ExternalResolver) (*Generator, error)

New returns a new Generator which is responsible for a Go repository.

"repoRoot" is a path to the root directory of the repository. "goPrefix" is the go_prefix corresponding to the repository root directory. See also https://github.com/bazelbuild/rules_go#go_prefix. "buildFileName" is the name of the BUILD file (BUILD or BUILD.bazel). "buildTags" is a comma-delimited set of build tags to set in the build context. "external" is how external packages should be resolved.

func (*Generator) Generate

func (g *Generator) Generate(dir string) ([]*bzl.File, error)

Generate generates a BUILD file for each Go package found under the given directory. The directory must be the repository root directory the caller passed to New, or its subdirectory.