Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildOption ¶
type BuildOption func(*buildOptions)
BuildOption is an option for Build.
func WithDirectDependencies ¶ added in v1.20.0
func WithDirectDependencies(directDependencies []bufmoduleref.ModuleReference) BuildOption
WithDirectDependencies sets direct module dependencies, so transitive imports can be warned.
func WithExcludeSourceCodeInfo ¶
func WithExcludeSourceCodeInfo() BuildOption
WithExcludeSourceCodeInfo returns a BuildOption that excludes sourceCodeInfo.
func WithLocalWorkspace ¶ added in v1.20.0
func WithLocalWorkspace(workspace bufmodule.Workspace) BuildOption
WithLocalWorkspace sets a local workspace, so imports from it are not warned.
type Builder ¶
type Builder interface {
// Build runs compilation.
//
// The FileRefs are assumed to have been created by a FileRefProvider, that is
// they are unique relative to the roots.
//
// If an error is returned, it is a system error.
// Only one of Image and FileAnnotations will be returned.
//
// FileAnnotations will use external file paths.
Build(
ctx context.Context,
moduleFileSet bufmodule.ModuleFileSet,
options ...BuildOption,
) (bufimage.Image, []bufanalysis.FileAnnotation, error)
}
Builder builds Protobuf files into Images.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.