forked from golangci/golangci-lint
-
Notifications
You must be signed in to change notification settings - Fork 1
/
bannedfunc.go
161 lines (143 loc) · 3.49 KB
/
bannedfunc.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
package golinters
import (
"go/ast"
"io/ioutil"
"os"
"strings"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"gopkg.in/yaml.v2"
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
"github.com/golangci/golangci-lint/pkg/lint/linter"
)
// Analyzer lint 插件的结构体
var Analyzer = &analysis.Analyzer{
Name: "bandfunc",
Doc: "Checks that cannot use func",
Requires: []*analysis.Analyzer{inspect.Analyzer},
}
type configSetting struct {
LinterSettings BandFunc `yaml:"linters-settings"`
}
// BandFunc 读取配置的结构体
type BandFunc struct {
Funcs map[string]string `yaml:"bannedfunc,flow"`
}
// NewCheckBannedFunc 返回检查函数
func NewCheckBannedFunc() *goanalysis.Linter {
return goanalysis.NewLinter(
"bannedfunc",
"Checks that cannot use func",
[]*analysis.Analyzer{Analyzer},
nil,
).WithContextSetter(linterCtx).WithLoadMode(goanalysis.LoadModeSyntax)
}
func linterCtx(lintCtx *linter.Context) {
// 读取配置文件
config := loadConfigFile()
configMap := configToConfigMap(config)
Analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
useMap := getUsedMap(pass, configMap)
for _, f := range pass.Files {
ast.Inspect(f, astFunc(pass, useMap))
}
return nil, nil
}
}
func astFunc(pass *analysis.Pass, usedMap map[string]map[string]string) func(node ast.Node) bool {
return func(node ast.Node) bool {
selector, ok := node.(*ast.SelectorExpr)
if !ok {
return true
}
ident, ok := selector.X.(*ast.Ident)
if !ok {
return true
}
m := usedMap[ident.Name]
if m == nil {
return true
}
sel := selector.Sel
value, ok := m[sel.Name]
if !ok {
return true
}
pass.Reportf(node.Pos(), value)
return true
}
}
// configToConfigMap 将配置文件转成 map
// map[包名]map[函数名]错误提示
// example:
// {
// time: {
// Now: 不能使用 time.Now() 请使用 MiaoSiLa/missevan-go/util 下 TimeNow()
// Date: xxxx
// },
// github.com/MiaoSiLa/missevan-go/util/time: {
// TimeNow: xxxxxx
// SetTimeNow: xxxxx
// }
// }
func configToConfigMap(config configSetting) map[string]map[string]string {
configMap := make(map[string]map[string]string)
for k, v := range config.LinterSettings.Funcs {
strs := strings.Split(k, ").")
if len(strs) != 2 {
continue
}
if len(strs[0]) <= 1 || strs[0][0] != '(' {
continue
}
pkg, name := strs[0][1:], strs[1]
if name == "" {
continue
}
m := configMap[pkg]
if m == nil {
m = make(map[string]string)
configMap[pkg] = m
}
m[name] = v
}
return configMap
}
func loadConfigFile() configSetting {
wd, _ := os.Getwd()
f, err := ioutil.ReadFile(wd + "/.golangci.yml")
if err != nil {
panic(err)
}
return decodeFile(f)
}
func decodeFile(b []byte) configSetting {
var config configSetting
err := yaml.Unmarshal(b, &config)
if err != nil {
panic(err)
}
return config
}
// getUsedMap 将配置文件的 map 转成文件下实际变量名的 map
// map[包的别名]map[函数名]错误提示
// example:
// {
// time: {
// Now: 不能使用 time.Now() 请使用 MiaoSiLa/missevan-go/util 下 TimeNow()
// Date: xxxx
// },
// util: {
// TimeNow: xxxxxx
// SetTimeNow: xxxxx
// }
// }
func getUsedMap(pass *analysis.Pass, configMap map[string]map[string]string) map[string]map[string]string {
useMap := make(map[string]map[string]string)
for _, item := range pass.Pkg.Imports() {
if m, ok := configMap[item.Path()]; ok {
useMap[item.Name()] = m
}
}
return useMap
}