appprotoos

Documentation

Overview

Package appprotoos does OS-specific generation.

Index

• Variables
• type GenerateOption
  • func GenerateWithCreateOutDirIfNotExists() GenerateOption
  • func GenerateWithPluginPath(pluginPath string) GenerateOption
• type Generator
  • func NewGenerator(logger *zap.Logger, storageosProvider storageos.Provider) Generator

Variables

var (
	ManifestPath    = normalpath.Join("META-INF", "MANIFEST.MF")
	ManifestContent = []byte(`Manifest-Version: 1.0
Created-By: 1.6.0 (protoc)

`)
)

Constants used to create .jar files

Types

type GenerateOption

type GenerateOption func(*generateOptions)

GenerateOption is an option for Generate.

func GenerateWithCreateOutDirIfNotExists

func GenerateWithCreateOutDirIfNotExists() GenerateOption

GenerateWithCreateOutDirIfNotExists returns a new GenerateOption that creates the directory if it does not exist.

func GenerateWithPluginPath

func GenerateWithPluginPath(pluginPath string) GenerateOption

GenerateWithPluginPath returns a new GenerateOption that uses the given path to the plugin.

type Generator

type Generator interface {
	// Generate generates to the os filesystem, switching on the file extension.
	// If there is a .jar extension, this generates a jar. If there is a .zip
	// extension, this generates a zip. If there is no extension, this outputs
	// to the directory.
	Generate(
		ctx context.Context,
		container app.EnvStderrContainer,
		pluginName string,
		pluginOut string,
		requests []*pluginpb.CodeGeneratorRequest,
		options ...GenerateOption,
	) error
}

func NewGenerator

func NewGenerator(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
) Generator

NewGenerator returns a new Generator.