generate

Documentation

Overview

Package generate runs `buf generate` against a prepared workspace, either in a Docker container (default) or with a host buf binary. A single backend is reused across all language jobs so per-language toolchain setup happens once.

Index

• Constants
• type Generator
  • func New(opts *Options, log *slog.Logger) (Generator, error)
• type Job
• type Options

Constants

const (
	RunnerAuto   = "auto"
	RunnerDocker = "docker"
	RunnerHost   = "host"
)

Runner selection values for Options.Runner.

Types

type Generator

type Generator interface {
	Generate(ctx context.Context, workspaceDir, outDir string, jobs []*Job) error
}

Generator runs buf for a set of jobs against a prepared workspace, writing generated code into outDir.

func New

func New(opts *Options, log *slog.Logger) (Generator, error)

New selects a generator per opts.Runner. "auto" prefers a host buf binary and falls back to Docker.

type Job

type Job struct {
	Lang         string // "go" | "js"
	TemplateFile string // buf gen template file name, relative to the workspace root
}

Job is a single language generation: which template within the workspace to run buf with.

type Options

type Options struct {
	Runner    string // auto | docker | host
	Image     string // Docker image, default "bufbuild/buf"
	Tag       string // Docker image tag, default "1.54.0"
	MemoryGiB int    // container memory limit in GiB, default 2
}

Options configures the generator. Zero values are replaced by defaults.