kinds

Documentation

Index

• Variables
• type Kind
  • func (k *Kind) IsProvided(i string) bool
• type Type

Variables

var DefaultKinds = map[string]*Kind{
	"go_library": {
		Name:     "go_library",
		Type:     Lib,
		SrcsAttr: "srcs",
	},
	"go_binary": {
		Name:     "go_binary",
		Type:     Bin,
		SrcsAttr: "srcs",
	},
	"go_test": {
		Name:     "go_test",
		Type:     Test,
		SrcsAttr: "srcs",
	},
	"go_benchmark": {
		Name:     "go_benchmark",
		Type:     Test,
		SrcsAttr: "srcs",
	},
	"proto_library": {
		Name:         "proto_library",
		Type:         Lib,
		NonGoSources: true,
	},
	"grpc_library": {
		Name:         "proto_library",
		Type:         Lib,
		NonGoSources: true,
	},
	"go_repo": {
		Name:              "go_repo",
		Type:              ThirdParty,
		DefaultVisibility: []string{"PUBLIC"},
	},
	"go_module": {
		Name: "go_repo",
		Type: ThirdParty,
	},
}

DefaultKinds are the base kinds that puku supports out of the box

Types

type Kind

type Kind struct {
	Name              string
	Type              Type
	ProvidedDeps      []string
	DefaultVisibility []string
	SrcsAttr          string
	// NonGoSources indicates the puku that the sources to this rule are not go so we shouldn't try to parse them to
	// infer their deps, for example, proto_library.
	NonGoSources bool
}

Kind is a kind of build target, e.g. go_library. These can either be library, test or binaries. They can also provide dependencies e.g. you could wrap go_test to add a common testing library, in which case, we should not add it as a dep.

func (*Kind) IsProvided

func (k *Kind) IsProvided(i string) bool

IsProvided returns whether the dependency is already provided by the kind, and therefore can be omitted from the deps list.

type Type

type Type int

const (
	Lib Type = iota
	Test
	Bin
	ThirdParty
)