/
appprotoos.go
68 lines (60 loc) · 2.15 KB
/
appprotoos.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
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright 2020-2022 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 appprotoos does OS-specific generation.
package appprotoos
import (
"context"
"io"
"github.com/bufbuild/buf/private/pkg/storage/storageos"
"go.uber.org/zap"
"google.golang.org/protobuf/types/pluginpb"
)
// ResponseWriter writes CodeGeneratorResponses to the OS filesystem.
type ResponseWriter interface {
// Close writes all of the responses to disk. No further calls can be
// made to the ResponseWriter after this call.
io.Closer
// AddResponse adds the response to the writer, 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.
//
// pluginOut will be unnormalized within this function.
AddResponse(
ctx context.Context,
response *pluginpb.CodeGeneratorResponse,
pluginOut string,
) error
}
// NewResponseWriter returns a new ResponseWriter.
func NewResponseWriter(
logger *zap.Logger,
storageosProvider storageos.Provider,
options ...ResponseWriterOption,
) ResponseWriter {
return newResponseWriter(
logger,
storageosProvider,
options...,
)
}
// ResponseWriterOption is an option for the ResponseWriter.
type ResponseWriterOption func(*responseWriterOptions)
// ResponseWriterWithCreateOutDirIfNotExists returns a new ResponseWriterOption that creates
// the directory if it does not exist.
func ResponseWriterWithCreateOutDirIfNotExists() ResponseWriterOption {
return func(responseWriterOptions *responseWriterOptions) {
responseWriterOptions.createOutDirIfNotExists = true
}
}