protoc

Documentation

Index

• func Exec(opts CompileOptions) error
• func ExecWithArgs(args []string, toolManager tools.ToolManager) error
• func WriteGeneratedFiles(resp *pluginpb.CodeGeneratorResponse, outputDir string) error
• type CompileOptions
• type Compiler
  • func NewCompiler(importPaths []string) *Compiler
  • func (c *Compiler) Compile(ctx context.Context, protoFiles []string) ([]*descriptorpb.FileDescriptorProto, error)
• type Generator
  • func NewGenerator(toolManager tools.ToolManager) *Generator
  • func (g *Generator) Execute(generatorName string, req *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse, error)
  • func (g *Generator) ExecuteGenerators(generators []GeneratorConfig, descriptors []*descriptorpb.FileDescriptorProto, ...) error
• type GeneratorConfig

Functions

func Exec

func Exec(opts CompileOptions) error

Exec executes protoc with structured options and mode selection

func ExecWithArgs

func ExecWithArgs(args []string, toolManager tools.ToolManager) error

ExecWithArgs executes protoc with raw arguments using pure-go implementation

func WriteGeneratedFiles

func WriteGeneratedFiles(resp *pluginpb.CodeGeneratorResponse, outputDir string) error

WriteGeneratedFiles writes the generated files from a CodeGeneratorResponse to disk

Types

type CompileOptions

type CompileOptions struct {
	ProtoFiles  []string          // Input .proto files
	ProtoPaths  []string          // --proto_path equivalent
	Generators  []GeneratorConfig // Generator configurations
	ToolManager tools.ToolManager // The tool manager for generator execution
}

CompileOptions represents structured compilation options

type Compiler

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

Compiler wraps protocompile.Compiler to provide pure-Go protobuf compilation

func NewCompiler

func NewCompiler(importPaths []string) *Compiler

NewCompiler creates a new Compiler instance with the given import paths

func (*Compiler) Compile

func (c *Compiler) Compile(ctx context.Context, protoFiles []string) ([]*descriptorpb.FileDescriptorProto, error)

Compile compiles the given proto files and returns their descriptors along with all dependencies

type Generator

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

Generator handles execution of protoc plugins for code generation

func NewGenerator

func NewGenerator(toolManager tools.ToolManager) *Generator

NewGenerator creates a new Generator instance with the given ToolManager

func (*Generator) Execute

func (g *Generator) Execute(generatorName string, req *pluginpb.CodeGeneratorRequest) (*pluginpb.CodeGeneratorResponse, error)

Execute executes a generator plugin with the given request

func (*Generator) ExecuteGenerators

func (g *Generator) ExecuteGenerators(generators []GeneratorConfig, descriptors []*descriptorpb.FileDescriptorProto, protoFiles []string) error

ExecuteGenerators executes multiple generators with the same request

type GeneratorConfig

type GeneratorConfig struct {
	Name    string   // Generator name (e.g., "go", "grpc")
	Out     string   // --<generator>_out equivalent
	Options []string // --<generator>_opt equivalent
}

GeneratorConfig represents a single generator configuration