buf

package

v0.8.15 Latest Latest Go to latest Published: May 20, 2023 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func AddArg(arg string) func(*bufArgs)

AddArg adds a simple argument.

func AddPaths(paths []string) func(*bufArgs)

func Build(binFile string, bufConfigs ...string) error

func BuildDir(dir, binFile string) error

func CreateDevWorkspace(protoDirs, dependencies []string) (func() error, error)

func Generate(binFile string, protoPluginPaths []string) error

Generate proto artifacts

func GenerateDev(binFile string, protoDirs, deps, protoPluginPaths []string) (err error)

func GetCommonProtoRepo() string

func Lint(bufConfigs ...string) error

func LintBin(binFile string, bufConfigs ...string) error

func ModUpdate(dirs ...string) error

func Run(args ...Arg) error

Run runs the protoc CLI

func RunWithEnv(env map[string]string, args ...Arg) (err error)

Run runs the protoc CLI with the given environment variables.

func WithLogin() func(*bufArgs)

type Arg func(*bufArgs)

Arg represents a protoc CLI argument

type Tag struct {
	Name        string `json:"name"`
	Commit      string `json:"commit"`
	CreatedTime string `json:"create_time"`
}

func GetLatestTag(repository string) (Tag, error)

Gets the latest commit based on create_date

func GetTags(repository string) ([]Tag, error)

Gets all the tags from a buf repository