forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
comments.go
98 lines (92 loc) · 2.69 KB
/
comments.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
// Copyright The OpenTelemetry Authors
//
// 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: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 configschema // import "github.com/open-telemetry/opentelemetry-collector-contrib/cmd/configschema"
import (
"go/ast"
"go/parser"
"go/token"
"io/fs"
"path/filepath"
"reflect"
"strings"
)
// commentsForStruct returns a map of fieldname -> comment for a struct
func commentsForStruct(v reflect.Value, dr DirResolver) (map[string]string, error) {
elem := v
if v.Kind() == reflect.Ptr {
elem = v.Elem()
}
packagePath, err := dr.TypeToPackagePath(elem.Type())
if err != nil {
return nil, err
}
return searchDirsForComments(packagePath, elem.Type().String())
}
func searchDirsForComments(packageDir, typeName string) (map[string]string, error) {
out := map[string]string{}
err := filepath.WalkDir(packageDir, func(path string, d fs.DirEntry, err error) error {
if d.IsDir() {
commentsForStructName(out, path, typeName)
}
return nil
})
return out, err
}
func commentsForStructName(comments map[string]string, dir, typeName string) {
fset := token.NewFileSet()
pkgs, err := parser.ParseDir(fset, dir, nil, parser.ParseComments)
if err != nil {
panic(err)
}
parts := strings.Split(typeName, ".")
targetPkg := parts[0]
targetType := parts[1]
for pkgName, pkg := range pkgs {
if pkgName != targetPkg {
continue
}
for _, file := range pkg.Files {
for _, decl := range file.Decls {
if gd, ok := decl.(*ast.GenDecl); ok {
for _, spec := range gd.Specs {
if ts, ok := spec.(*ast.TypeSpec); ok {
if ts.Name.Name == targetType {
if structComments := gd.Doc.Text(); structComments != "" {
comments["_struct"] = structComments
}
if st, ok := ts.Type.(*ast.StructType); ok {
for _, field := range st.Fields.List {
if name := fieldName(field); name != "" {
comments[name] = field.Doc.Text()
}
}
}
}
}
}
}
}
}
}
}
func fieldName(field *ast.Field) string {
if field.Names != nil {
return field.Names[0].Name
} else if se, ok := field.Type.(*ast.SelectorExpr); ok {
return se.Sel.Name
} else if id, ok := field.Type.(*ast.Ident); ok {
return id.Name
}
return ""
}