/
time_field_type.go
54 lines (50 loc) · 1.72 KB
/
time_field_type.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
// Copyright 2019 Google LLC
//
// 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
//
// https://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 aip0142
import (
"strings"
"bitbucket.org/creachadair/stringset"
"github.com/googleapis/api-linter/lint"
"github.com/googleapis/api-linter/locations"
"github.com/googleapis/api-linter/rules/internal/utils"
"github.com/jhump/protoreflect/desc"
)
var fieldType = &lint.FieldRule{
Name: lint.NewRuleName(142, "time-field-type"),
LintField: func(f *desc.FieldDescriptor) []lint.Problem {
tokens := strings.Split(f.GetName(), "_")
suffix := tokens[len(tokens)-1]
typeName := utils.GetTypeName(f)
suffixes := stringset.New(
"date", "datetime", "ms", "msec", "msecs", "millis", "nanos", "ns",
"nsec", "nsecs", "sec", "secs", "seconds", "time", "timestamp", "us",
"usec", "usecs",
)
allowed := stringset.New(
"google.protobuf.Timestamp",
"google.type.Date",
"google.type.DateTime",
"google.type.TimeOfDay",
)
if suffixes.Contains(suffix) && !allowed.Contains(typeName) {
return []lint.Problem{{
Message: "Fields representing timestamps should use `google.protobuf.Timestamp`.",
Suggestion: "google.protobuf.Timestamp",
Descriptor: f,
Location: locations.FieldType(f),
}}
}
return nil
},
}