|
| 1 | +package goanalysis |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "flag" |
| 6 | + "fmt" |
| 7 | + "strings" |
| 8 | + |
| 9 | + "github.com/pkg/errors" |
| 10 | + "golang.org/x/tools/go/analysis" |
| 11 | + |
| 12 | + "github.com/golangci/golangci-lint/pkg/golinters/goanalysis/checker" |
| 13 | + "github.com/golangci/golangci-lint/pkg/lint/linter" |
| 14 | + "github.com/golangci/golangci-lint/pkg/result" |
| 15 | +) |
| 16 | + |
| 17 | +type Linter struct { |
| 18 | + name, desc string |
| 19 | + analyzers []*analysis.Analyzer |
| 20 | + cfg map[string]map[string]interface{} |
| 21 | +} |
| 22 | + |
| 23 | +func NewLinter(name, desc string, analyzers []*analysis.Analyzer, cfg map[string]map[string]interface{}) *Linter { |
| 24 | + return &Linter{name: name, desc: desc, analyzers: analyzers, cfg: cfg} |
| 25 | +} |
| 26 | + |
| 27 | +func (lnt Linter) Name() string { |
| 28 | + return lnt.name |
| 29 | +} |
| 30 | + |
| 31 | +func (lnt Linter) Desc() string { |
| 32 | + return lnt.desc |
| 33 | +} |
| 34 | + |
| 35 | +func (lnt Linter) allAnalyzerNames() []string { |
| 36 | + var ret []string |
| 37 | + for _, a := range lnt.analyzers { |
| 38 | + ret = append(ret, a.Name) |
| 39 | + } |
| 40 | + return ret |
| 41 | +} |
| 42 | + |
| 43 | +func allFlagNames(fs *flag.FlagSet) []string { |
| 44 | + var ret []string |
| 45 | + fs.VisitAll(func(f *flag.Flag) { |
| 46 | + ret = append(ret, f.Name) |
| 47 | + }) |
| 48 | + return ret |
| 49 | +} |
| 50 | + |
| 51 | +func valueToString(v interface{}) string { |
| 52 | + if ss, ok := v.([]string); ok { |
| 53 | + return strings.Join(ss, ",") |
| 54 | + } |
| 55 | + |
| 56 | + if is, ok := v.([]interface{}); ok { |
| 57 | + var ss []string |
| 58 | + for _, i := range is { |
| 59 | + ss = append(ss, fmt.Sprint(i)) |
| 60 | + } |
| 61 | + return valueToString(ss) |
| 62 | + } |
| 63 | + |
| 64 | + return fmt.Sprint(v) |
| 65 | +} |
| 66 | + |
| 67 | +func (lnt Linter) configureAnalyzer(a *analysis.Analyzer, cfg map[string]interface{}) error { |
| 68 | + for k, v := range cfg { |
| 69 | + f := a.Flags.Lookup(k) |
| 70 | + if f == nil { |
| 71 | + validFlagNames := allFlagNames(&a.Flags) |
| 72 | + if len(validFlagNames) == 0 { |
| 73 | + return fmt.Errorf("analyzer doesn't have settings") |
| 74 | + } |
| 75 | + |
| 76 | + return fmt.Errorf("analyzer doesn't have setting %q, valid settings: %v", |
| 77 | + k, validFlagNames) |
| 78 | + } |
| 79 | + |
| 80 | + if err := f.Value.Set(valueToString(v)); err != nil { |
| 81 | + return errors.Wrapf(err, "failed to set analyzer setting %q with value %v", k, v) |
| 82 | + } |
| 83 | + } |
| 84 | + |
| 85 | + return nil |
| 86 | +} |
| 87 | + |
| 88 | +func (lnt Linter) configure() error { |
| 89 | + analyzersMap := map[string]*analysis.Analyzer{} |
| 90 | + for _, a := range lnt.analyzers { |
| 91 | + analyzersMap[a.Name] = a |
| 92 | + } |
| 93 | + |
| 94 | + for analyzerName, analyzerSettings := range lnt.cfg { |
| 95 | + a := analyzersMap[analyzerName] |
| 96 | + if a == nil { |
| 97 | + return fmt.Errorf("settings key %q must be valid analyzer name, valid analyzers: %v", |
| 98 | + analyzerName, lnt.allAnalyzerNames()) |
| 99 | + } |
| 100 | + |
| 101 | + if err := lnt.configureAnalyzer(a, analyzerSettings); err != nil { |
| 102 | + return errors.Wrapf(err, "failed to configure analyzer %s", analyzerName) |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + return nil |
| 107 | +} |
| 108 | + |
| 109 | +func (lnt Linter) Run(ctx context.Context, lintCtx *linter.Context) ([]result.Issue, error) { |
| 110 | + if err := analysis.Validate(lnt.analyzers); err != nil { |
| 111 | + return nil, errors.Wrap(err, "failed to validate analyzers") |
| 112 | + } |
| 113 | + |
| 114 | + if err := lnt.configure(); err != nil { |
| 115 | + return nil, errors.Wrap(err, "failed to configure analyzers") |
| 116 | + } |
| 117 | + |
| 118 | + diags, errs := checker.Run(lnt.analyzers, lintCtx.Packages) |
| 119 | + for i := 1; i < len(errs); i++ { |
| 120 | + lintCtx.Log.Warnf("%s error: %s", lnt.Name(), errs[i]) |
| 121 | + } |
| 122 | + if len(errs) != 0 { |
| 123 | + return nil, errs[0] |
| 124 | + } |
| 125 | + |
| 126 | + var issues []result.Issue |
| 127 | + for _, diag := range diags { |
| 128 | + i := result.Issue{ |
| 129 | + FromLinter: lnt.Name(), |
| 130 | + Text: fmt.Sprintf("%s: %s", diag.AnalyzerName, diag.Message), |
| 131 | + Pos: diag.Position, |
| 132 | + } |
| 133 | + issues = append(issues, i) |
| 134 | + } |
| 135 | + |
| 136 | + return issues, nil |
| 137 | +} |
0 commit comments