Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildModuleFileSetOption ¶ added in v0.42.0
type BuildModuleFileSetOption func(*buildModuleFileSetOptions)
BuildModuleFileSetOption is an option for Build.
func WithWorkspace ¶ added in v0.42.0
func WithWorkspace(workspace bufmodule.Workspace) BuildModuleFileSetOption
WithWorkspace returns a new BuildModuleFileSetOption that specifies a workspace.
type BuildOption ¶
type BuildOption func(*buildOptions)
BuildOption is an option for BuildForBucket.
func WithModuleIdentity ¶ added in v0.44.0
func WithModuleIdentity(moduleIdentity bufmodule.ModuleIdentity) BuildOption
WithModuleIdentity returns a new BuildOption that is used to construct a Module with a ModuleIdentity.
TODO: this is never called TODO: we also have ModuleWithModuleIdentityAndCommit in bufmodule We need to disambiguate module building between bufmodule and bufmodulebuild bufimage and bufimagebuild work, but bufmodule and bufmodulebuild are a mess
func WithPaths ¶
func WithPaths(paths []string) BuildOption
WithPaths returns a new BuildOption that specifies specific file or directory paths to build.
These paths must exist. These paths must be relative to the bucket or include directory paths. These paths will be normalized. Multiple calls to this option and WithPathsAllowNotExist will override previous calls.
This results in ModuleWithTargetPaths being used on the resulting build module. This is done within bufmodulebuild so we can resolve the paths relative to their roots.
func WithPathsAllowNotExist ¶
func WithPathsAllowNotExist(paths []string) BuildOption
WithPathsAllowNotExist returns a new BuildOption that specifies specific file or directory paths to build, but allows the specified paths to not exist.
These paths must exist. These paths must be relative to the bucket or include directory paths. These paths will be normalized. Multiple calls to this option and WithPaths will override previous calls.
This results in ModuleWithTargetPathsAllowNotExist being used on the resulting build module. This is done within bufmodulebuild so we can resolve the paths relative to their roots.
type Config ¶
type Config struct {
// RootToExcludes contains a map from root to the excludes for that root.
//
// Roots are the root directories within a bucket to search for Protobuf files.
//
// There will be no between the roots, ie foo/bar and foo are not allowed.
// All Protobuf files must be unique relative to the roots, ie if foo and bar
// are roots, then foo/baz.proto and bar/baz.proto are not allowed.
//
// All roots will be normalized and validated.
//
// Excludes are the directories within a bucket to exclude.
//
// There should be no overlap between the excludes, ie foo/bar and foo are not allowed.
//
// All excludes must reside within a root, but none will be equal to a root.
// All excludes will be normalized and validated.
// The excludes in this map will be relative to the root they map to!
//
// If RootToExcludes is empty, the default is "." with no excludes.
RootToExcludes map[string][]string
DependencyModuleReferences []bufmodule.ModuleReference
}
Config is a configuration for build.
func NewConfigV1 ¶ added in v0.44.0
func NewConfigV1(externalConfig ExternalConfigV1, deps ...string) (*Config, error)
NewConfigV1 returns a new, validated Config for the ExternalConfig.
func NewConfigV1Beta1 ¶ added in v0.25.0
func NewConfigV1Beta1(externalConfig ExternalConfigV1Beta1, deps ...string) (*Config, error)
NewConfigV1Beta1 returns a new, validated Config for the ExternalConfig.
type ExternalConfigV1 ¶ added in v0.44.0
type ExternalConfigV1 struct {
Excludes []string `json:"excludes,omitempty" yaml:"excludes,omitempty"`
}
ExternalConfigV1 is an external config.
type ExternalConfigV1Beta1 ¶ added in v0.25.0
type ExternalConfigV1Beta1 struct {
Roots []string `json:"roots,omitempty" yaml:"roots,omitempty"`
Excludes []string `json:"excludes,omitempty" yaml:"excludes,omitempty"`
}
ExternalConfigV1Beta1 is an external config.
type ModuleBucketBuilder ¶
type ModuleBucketBuilder interface {
// BuildForBucket builds a module for the given bucket.
//
// If paths is empty, all files are built.
// Paths should be relative to the bucket, not the roots.
BuildForBucket(
ctx context.Context,
readBucket storage.ReadBucket,
config *Config,
options ...BuildOption,
) (bufmodule.Module, error)
}
ModuleBucketBuilder builds modules for buckets.
func NewModuleBucketBuilder ¶
func NewModuleBucketBuilder(logger *zap.Logger) ModuleBucketBuilder
NewModuleBucketBuilder returns a new BucketBuilder.
type ModuleFileSetBuilder ¶
type ModuleFileSetBuilder interface {
Build(
ctx context.Context,
module bufmodule.Module,
options ...BuildModuleFileSetOption,
) (bufmodule.ModuleFileSet, error)
}
ModuleFileSetBuilder builds ModuleFileSets from Modules.
func NewModuleFileSetBuilder ¶
func NewModuleFileSetBuilder( logger *zap.Logger, moduleReader bufmodule.ModuleReader, ) ModuleFileSetBuilder
NewModuleFileSetBuilder returns a new ModuleSetProvider.
type ModuleIncludeBuilder ¶
type ModuleIncludeBuilder interface {
// BuildForIncludes builds a module for the given includes and file paths.
BuildForIncludes(
ctx context.Context,
includeDirPaths []string,
options ...BuildOption,
) (bufmodule.Module, error)
}
ModuleIncludeBuilder builds modules for includes.
This is used for protoc.
func NewModuleIncludeBuilder ¶
func NewModuleIncludeBuilder( logger *zap.Logger, storageosProvider storageos.Provider, ) ModuleIncludeBuilder
NewModuleIncludeBuilder returns a new ModuleIncludeBuilder.
TODO: we should parse includeDirPaths for modules as well in theory would be nice to be able to do buf protoc -I path/to/dir -I buf.build/foo/bar/v1
Source Files