collector

Documentation

Index

• Variables
• func NewCollector(customImports, commonImports []string) *collector
• func NewProtoCompiler(collector Collector, executor ProtocExecutor) *protoCompiler
• type Collector
• type DefaultProtocExecutor
  • func (d *DefaultProtocExecutor) Execute(protoFile string, toFile string, imports []string) error
• type ImportsExtractor
  • func NewSynchronizedImportsExtractor() ImportsExtractor
• type ImportsFetcher
• type OpenApiProtocExecutor
  • func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports []string) error
• type ProtoCompiler
• type ProtocExecutor

Variables

var (
	FetchImportsTimeout = func(filename string) error {
		return eris.Errorf("Timed out while fetching imports for proto file: [%s]", filename)
	}
)

Functions

func NewCollector

func NewCollector(customImports, commonImports []string) *collector

func NewProtoCompiler

func NewProtoCompiler(collector Collector, executor ProtocExecutor) *protoCompiler

Types

type Collector

type Collector interface {
	CollectImportsForFile(root, protoFile string) ([]string, error)
}

type DefaultProtocExecutor

type DefaultProtocExecutor struct {
	// The output directory
	OutputDir string
	// whether or not to do a regular go-proto generate while collecting descriptors
	ShouldCompileFile func(string) bool
	// arguments for go_out=
	CustomGoArgs []string
	// custom plugins
	// each will append a <plugin>_out= directive to protoc command
	CustomPlugins []string
}

func (*DefaultProtocExecutor) Execute

func (d *DefaultProtocExecutor) Execute(protoFile string, toFile string, imports []string) error

type ImportsExtractor

type ImportsExtractor interface {
	FetchImportsForFile(protoFile string, importsFetcher ImportsFetcher) ([]string, error)
}

func NewSynchronizedImportsExtractor

func NewSynchronizedImportsExtractor() ImportsExtractor

type ImportsFetcher

type ImportsFetcher func(file string) ([]string, error)

type OpenApiProtocExecutor

type OpenApiProtocExecutor struct {
	OutputDir string

	// Whether to include descriptions in validation schemas
	IncludeDescriptionsInSchema bool

	// The maximum number of characters to include in a description
	// A 0 value will be interpreted as "include all characters"
	// Default: 0
	MaxDescriptionCharacters int

	// Whether to assign Enum fields the `x-kubernetes-int-or-string` property
	// which allows the value to either be an integer or a string
	EnumAsIntOrString bool
}

func (*OpenApiProtocExecutor) Execute

func (o *OpenApiProtocExecutor) Execute(protoFile string, toFile string, imports []string) error

type ProtoCompiler

type ProtoCompiler interface {
	CompileDescriptorsFromRoot(root string, skipDirs []string) ([]*model.DescriptorWithPath, error)
}

type ProtocExecutor

type ProtocExecutor interface {
	Execute(protoFile string, toFile string, imports []string) error
}