-
Notifications
You must be signed in to change notification settings - Fork 256
/
helper.go
171 lines (160 loc) · 4.25 KB
/
helper.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
// Copyright 2020-2023 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 internal
import (
"fmt"
"github.com/bufbuild/buf/private/bufpkg/bufanalysis"
"github.com/bufbuild/buf/private/pkg/protosource"
)
// Helper is a helper for rules.
type Helper struct {
id string
ignoreFunc IgnoreFunc
fileAnnotations []bufanalysis.FileAnnotation
}
// NewHelper returns a new Helper for the given id.
func NewHelper(id string, ignoreFunc IgnoreFunc) *Helper {
return &Helper{
id: id,
ignoreFunc: ignoreFunc,
}
}
// AddFileAnnotationf adds a FileAnnotation with the id as the Type.
//
// If descriptor is nil, no filename information is added.
// If location is nil, no line or column information will be added.
func (h *Helper) AddFileAnnotationf(
descriptor protosource.Descriptor,
location protosource.Location,
format string,
args ...interface{},
) {
h.addFileAnnotationf(
descriptor,
nil,
location,
nil,
format,
args...,
)
}
// AddFileAnnotationWithExtraIgnoreDescriptorsf adds a FileAnnotation with the id as the Type.
//
// extraIgnoreDescriptors are extra desciptors to check for ignores.
//
// If descriptor is nil, no filename information is added.
// If location is nil, no line or column information will be added.
func (h *Helper) AddFileAnnotationWithExtraIgnoreDescriptorsf(
descriptor protosource.Descriptor,
extraIgnoreDescriptors []protosource.Descriptor,
location protosource.Location,
format string,
args ...interface{},
) {
h.addFileAnnotationf(
descriptor,
extraIgnoreDescriptors,
location,
nil,
format,
args...,
)
}
// AddFileAnnotationWithExtraIgnoreLocationsf adds a FileAnnotation with the id as the Type.
//
// extraIgnoreLocations are extra locations to check for comment ignores.
//
// If descriptor is nil, no filename information is added.
// If location is nil, no line or column information will be added.
func (h *Helper) AddFileAnnotationWithExtraIgnoreLocationsf(
descriptor protosource.Descriptor,
location protosource.Location,
extraIgnoreLocations []protosource.Location,
format string,
args ...interface{},
) {
h.addFileAnnotationf(
descriptor,
nil,
location,
extraIgnoreLocations,
format,
args...,
)
}
func (h *Helper) addFileAnnotationf(
descriptor protosource.Descriptor,
extraIgnoreDescriptors []protosource.Descriptor,
location protosource.Location,
extraIgnoreLocations []protosource.Location,
format string,
args ...interface{},
) {
if h.ignoreFunc != nil && h.ignoreFunc(
h.id,
append([]protosource.Descriptor{descriptor}, extraIgnoreDescriptors...),
append([]protosource.Location{location}, extraIgnoreLocations...),
) {
return
}
h.fileAnnotations = append(
h.fileAnnotations,
newFileAnnotationf(
h.id,
descriptor,
location,
format,
args...,
),
)
}
// FileAnnotations returns the added FileAnnotations.
func (h *Helper) FileAnnotations() []bufanalysis.FileAnnotation {
return h.fileAnnotations
}
// newFileAnnotationf adds a FileAnnotation with the id as the Type.
//
// If descriptor is nil, no filename information is added.
// If location is nil, no line or column information will be added.
func newFileAnnotationf(
id string,
descriptor protosource.Descriptor,
location protosource.Location,
format string,
args ...interface{},
) bufanalysis.FileAnnotation {
startLine := 0
startColumn := 0
endLine := 0
endColumn := 0
if location != nil {
startLine = location.StartLine()
startColumn = location.StartColumn()
endLine = location.EndLine()
endColumn = location.EndColumn()
}
var fileInfo bufanalysis.FileInfo
if descriptor != nil {
fileInfo = descriptor.File()
}
return bufanalysis.NewFileAnnotation(
fileInfo,
startLine,
startColumn,
endLine,
endColumn,
id,
fmt.Sprintf(format, args...),
)
}