settings

Documentation

Index

• Variables
• type CompileConfig
• type Config
• type ConfigProvider
  • func NewConfigProvider(options ...ConfigProviderOption) ConfigProvider
• type ConfigProviderOption
  • func ConfigProviderWithLogger(logger *zap.Logger) ConfigProviderOption
• type CreateConfig
• type ExternalConfig
• type GenConfig
• type GenGoPluginOptions
• type GenPlugin
• type GenPluginType
  • func ParseGenPluginType(s string) (GenPluginType, error)
  • func (g GenPluginType) IsGo() bool
  • func (g GenPluginType) IsGogo() bool
  • func (g GenPluginType) String() string
• type LintConfig
• type OutputPath

Variables

var (
	// ConfigFilenames are all possible config filenames.
	ConfigFilenames = []string{
		DefaultConfigFilename,
		"prototool.json",
	}
)

Types

type CompileConfig

type CompileConfig struct {
	// The Protobuf version to use from https://github.com/protocolbuffers/protobuf/releases.
	// Must have a valid protoc zip file asset, so for example 3.5.0 is a valid version
	// but 3.5.0.1 is not.
	ProtobufVersion string
	// IncludePaths are the additional paths to include with -I to protoc.
	// Expected to be absolute paths.
	// Expected to be unique.
	IncludePaths []string
	// IncludeWellKnownTypes says to add the Google well-known types with -I to protoc.
	IncludeWellKnownTypes bool
	// AllowUnusedImports says to not error when an import is not used.
	AllowUnusedImports bool
}

CompileConfig is the compile config.

type Config

type Config struct {
	// The working directory path.
	// Expected to be absolute path.
	DirPath string
	// The prefixes to exclude.
	// Expected to be absolute paths.
	// Expected to be unique.
	ExcludePrefixes []string
	// The compile config.
	Compile CompileConfig
	// The create config.
	Create CreateConfig
	// Lint is a special case. If nothing is set, the defaults are used. Either IDs,
	// or Group/IncludeIDs/ExcludeIDs can be set, but not both. There can be no overlap
	// between IncludeIDs and ExcludeIDs.
	Lint LintConfig
	// The gen config.
	Gen GenConfig
}

Config is the main config.

Configs are derived from ExternalConfigs, which represent the Config in a more palpable format for configuration via a config file or flags.

String slices will be deduped and sorted if returned from this package. Configs will be validated if returned from this package.

All paths returned should be absolute paths. Outside of this package, all other internal packages should verify that all given paths are absolute, except for the internal/text package.

type ConfigProvider

type ConfigProvider interface {
	// GetForDir tries to find a file named by one of the ConfigFilenames starting in the
	// given directory, and going up a directory until hitting root.
	//
	// The directory must be an absolute path.
	//
	// If such a file is found, it is read as an ExternalConfig and converted to a Config.
	// If no such file is found, Config{} is returned.
	// If multiple files named by one of the ConfigFilenames are found in the same
	// directory, error is returned.
	GetForDir(dirPath string) (Config, error)
	// Get tries to find a file named filePath with a config.
	//
	// The path must be an absolute path.
	// The file must have either the extension .yaml or .json.
	//
	// If such a file is found, it is read as an ExternalConfig and converted to a Config.
	// If no such file is found, Config{} is returned.
	Get(filePath string) (Config, error)
	// GetFilePathForDir tries to find a file named by one of the ConfigFilenames starting in the
	// given directory, and going up a directory until hitting root.
	//
	// The directory must be an absolute path.
	//
	// If such a file is found, it is returned.
	// If no such file is found, "" is returned.
	// If multiple files named by one of the ConfigFilenames are found in the same
	// directory, error is returned.
	GetFilePathForDir(dirPath string) (string, error)
	// GetForData returns a Config for the given ExternalConfigData in JSON format.
	// The Config will be as if there was a configuration file at the given dirPath.
	GetForData(dirPath string, externalConfigData string) (Config, error)

	// GetExcludePrefixesForDir tries to find a file named by one of the ConfigFilenames in the given
	// directory and returns the cleaned absolute exclude prefixes. Unlike other functions
	// on ConfigProvider, this has no recursive functionality - if there is no
	// config file, nothing is returned.
	// If multiple files named by one of the ConfigFilenames are found in the same
	// directory, error is returned.
	GetExcludePrefixesForDir(dirPath string) ([]string, error)
	// GetExcludePrefixesForData gets the exclude prefixes for the given ExternalConfigData in JSON format.
	// The logic will act is if there was a configuration file at the given dirPath.
	GetExcludePrefixesForData(dirPath string, externalConfigData string) ([]string, error)
}

ConfigProvider provides Configs.

func NewConfigProvider

func NewConfigProvider(options ...ConfigProviderOption) ConfigProvider

NewConfigProvider returns a new ConfigProvider.

type ConfigProviderOption

type ConfigProviderOption func(*configProvider)

ConfigProviderOption is an option for a new ConfigProvider.

func ConfigProviderWithLogger

func ConfigProviderWithLogger(logger *zap.Logger) ConfigProviderOption

ConfigProviderWithLogger returns a ConfigProviderOption that uses the given logger.

The default is to use zap.NewNop().

type CreateConfig

type CreateConfig struct {
	// The map from directory to the package to use as the base.
	// Directories expected to be absolute paths.
	DirPathToBasePackage map[string]string
}

CreateConfig is the create config.

type ExternalConfig

type ExternalConfig struct {
	Excludes []string `json:"excludes,omitempty" yaml:"excludes,omitempty"`
	Protoc   struct {
		AllowUnusedImports bool     `json:"allow_unused_imports,omitempty" yaml:"allow_unused_imports,omitempty"`
		Version            string   `json:"version,omitempty" yaml:"version,omitempty"`
		Includes           []string `json:"includes,omitempty" yaml:"includes,omitempty"`
	} `json:"protoc,omitempty" yaml:"protoc,omitempty"`
	Create struct {
		Packages []struct {
			Directory string `json:"directory,omitempty" yaml:"directory,omitempty"`
			Name      string `json:"name,omitempty" yaml:"name,omitempty"`
		} `json:"packages,omitempty" yaml:"packages,omitempty"`
	} `json:"create,omitempty" yaml:"create,omitempty"`
	Lint struct {
		Ignores []struct {
			ID    string   `json:"id,omitempty" yaml:"id,omitempty"`
			Files []string `json:"files,omitempty" yaml:"files,omitempty"`
		}
		Rules struct {
			NoDefault bool     `json:"no_default,omitempty" yaml:"no_default,omitempty"`
			Add       []string `json:"add" yaml:"add"`
			Remove    []string `json:"remove" yaml:"remove"`
		}
	} `json:"lint,omitempty" yaml:"lint,omitempty"`
	Gen struct {
		GoOptions struct {
			ImportPath     string            `json:"import_path,omitempty" yaml:"import_path,omitempty"`
			ExtraModifiers map[string]string `json:"extra_modifiers,omitempty" yaml:"extra_modifiers,omitempty"`
		} `json:"go_options,omitempty" yaml:"go_options,omitempty"`
		Plugins []struct {
			Name   string `json:"name,omitempty" yaml:"name,omitempty"`
			Type   string `json:"type,omitempty" yaml:"type,omitempty"`
			Flags  string `json:"flags,omitempty" yaml:"flags,omitempty"`
			Output string `json:"output,omitempty" yaml:"output,omitempty"`
			Path   string `json:"path,omitempty" yaml:"path,omitempty"`
		} `json:"plugins,omitempty" yaml:"plugins,omitempty"`
	} `json:"generate,omitempty" yaml:"generate,omitempty"`
}

ExternalConfig is the external representation of Config.

It is meant to be set by a YAML or JSON config file, or flags.

type GenConfig

type GenConfig struct {
	// The go plugin options.
	GoPluginOptions GenGoPluginOptions
	// The plugins.
	// These will be sorted by name if returned from this package.
	Plugins []GenPlugin
}

GenConfig is the gen config.

type GenGoPluginOptions

type GenGoPluginOptions struct {
	// The base import path. This should be the go path of the config file.
	// This is required for go plugins.
	ImportPath string
	// ExtraModifiers to include with Mfile=package.
	ExtraModifiers map[string]string
}

GenGoPluginOptions are options for go plugins.

This will be used for plugin types go, gogo, gogrpc, gogogrpc.

type GenPlugin

type GenPlugin struct {
	// The name of the plugin. For example, if you want to use
	// protoc-gen-gogoslick, the name is "gogoslick".
	Name string
	// The path to the executable. For example, if the name is "grpc-cpp"
	// but the path to the executable "protoc-gen-grpc-cpp" is "/usr/local/bin/grpc_cpp_plugin",
	// then this will be "/usr/local/bin/grpc_cpp_plugin".
	Path string
	// The type, if any. This will be GenPluginTypeNone if
	// there is no specific type.
	Type GenPluginType
	// Extra flags to pass.
	// If there is an associated type, some flags may be generated,
	// for example plugins=grpc or Mfile=package modifiers.
	Flags string
	// The path to output to.
	// Must be relative in a config file.
	OutputPath OutputPath
}

GenPlugin is a plugin to use.

type GenPluginType

type GenPluginType int

GenPluginType is a type of protoc plugin.

const (
	// DefaultConfigFilename is the default config filename.
	DefaultConfigFilename = "prototool.yaml"

	// GenPluginTypeNone says there is no specific plugin type.
	GenPluginTypeNone GenPluginType = iota
	// GenPluginTypeGo says the plugin is a Golang plugin that
	// is or uses github.com/golang/protobuf.
	// This will use GenGoPluginOptions.
	GenPluginTypeGo
	// GenPluginTypeGogo says the plugin is a Golang plugin that
	// is or uses github.com/gogo/protobuf.
	// This will use GenGoPluginOptions.
	GenPluginTypeGogo
)

func ParseGenPluginType

func ParseGenPluginType(s string) (GenPluginType, error)

ParseGenPluginType parses the GenPluginType from the given string.

Input is case-insensitive.

func (GenPluginType) IsGo

func (g GenPluginType) IsGo() bool

IsGo returns true if the plugin type is associated with github.com/golang/protobuf.

func (GenPluginType) IsGogo

func (g GenPluginType) IsGogo() bool

IsGogo returns true if the plugin type is associated with github.com/gogo/protobuf.

func (GenPluginType) String

func (g GenPluginType) String() string

String implements fmt.Stringer.

type LintConfig

type LintConfig struct {
	// NoDefault is set to exclude the default set of linters.
	NoDefault bool
	// IncludeIDs are the list of linter IDs to use in addition to the defaults.
	// Expected to be all uppercase.
	// Expected to be unique.
	// Expected to have no overlap with ExcludeIDs.
	IncludeIDs []string
	// ExcludeIDs are the list of linter IDs to exclude from the defaults.
	// Expected to be all uppercase.
	// Expected to be unique.
	// Expected to have no overlap with IncludeIDs.
	ExcludeIDs []string
	// IgnoreIDToFilePaths is the map of ID to absolute file path to ignore.
	// IDs expected to be all upper-case.
	// File paths expected to be absolute paths.
	IgnoreIDToFilePaths map[string][]string
}

LintConfig is the lint config.

type OutputPath

type OutputPath struct {
	// Must be relative.
	RelPath string
	AbsPath string
}

OutputPath is an output path.

We need the relative path for go package references for generation. TODO: we might want all paths to have the given path and absolute path, see if we need this.