-
Notifications
You must be signed in to change notification settings - Fork 245
/
bufbuild.go
56 lines (49 loc) · 1.67 KB
/
bufbuild.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Copyright 2020 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bufbuild
import (
"context"
"github.com/bufbuild/buf/internal/buf/bufanalysis"
"github.com/bufbuild/buf/internal/buf/bufcore"
"go.uber.org/zap"
)
// Builder builds Protobuf files into Images.
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,
module bufcore.Module,
options ...BuildOption,
) (bufcore.Image, []bufanalysis.FileAnnotation, error)
}
// NewBuilder returns a new Builder.
func NewBuilder(logger *zap.Logger) Builder {
return newBuilder(logger)
}
// BuildOption is an option for Build.
type BuildOption func(*buildOptions)
// WithExcludeSourceCodeInfo returns a BuildOption that excludes sourceCodeInfo.
func WithExcludeSourceCodeInfo() BuildOption {
return func(buildOptions *buildOptions) {
buildOptions.excludeSourceCodeInfo = true
}
}