Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update gochecknoglobals, use source analyzer (#1422)
- Loading branch information
Showing
6 changed files
with
39 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,100 +1,30 @@ | ||
| package golinters | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "go/ast" | ||
| "go/token" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "golang.org/x/tools/go/analysis" | ||
|
|
||
| "4d63.com/gochecknoglobals/checknoglobals" | ||
|
|
||
| "github.com/golangci/golangci-lint/pkg/golinters/goanalysis" | ||
| "github.com/golangci/golangci-lint/pkg/lint/linter" | ||
| "github.com/golangci/golangci-lint/pkg/result" | ||
| ) | ||
|
|
||
| const gochecknoglobalsName = "gochecknoglobals" | ||
|
|
||
| //nolint:dupl | ||
| func NewGochecknoglobals() *goanalysis.Linter { | ||
| var mu sync.Mutex | ||
| var resIssues []goanalysis.Issue | ||
|
|
||
| analyzer := &analysis.Analyzer{ | ||
| Name: gochecknoglobalsName, | ||
| Doc: goanalysis.TheOnlyanalyzerDoc, | ||
| Run: func(pass *analysis.Pass) (interface{}, error) { | ||
| var res []goanalysis.Issue | ||
| for _, file := range pass.Files { | ||
| fileIssues := checkFileForGlobals(file, pass.Fset) | ||
| for i := range fileIssues { | ||
| res = append(res, goanalysis.NewIssue(&fileIssues[i], pass)) | ||
| } | ||
| } | ||
| if len(res) == 0 { | ||
| return nil, nil | ||
| } | ||
|
|
||
| mu.Lock() | ||
| resIssues = append(resIssues, res...) | ||
| mu.Unlock() | ||
|
|
||
| return nil, nil | ||
| gochecknoglobals := checknoglobals.Analyzer() | ||
|
|
||
| // gochecknoglobals only lints test files if the `-t` flag is passed so we | ||
| // pass the `t` flag as true to the analyzer before running it. This can be | ||
| // turned of by using the regular golangci-lint flags such as `--tests` or | ||
| // `--skip-files`. | ||
| linterConfig := map[string]map[string]interface{}{ | ||
| gochecknoglobals.Name: { | ||
| "t": true, | ||
| }, | ||
| } | ||
| return goanalysis.NewLinter( | ||
| gochecknoglobalsName, | ||
| "Checks that no globals are present in Go code", | ||
| []*analysis.Analyzer{analyzer}, | ||
| nil, | ||
| ).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue { | ||
| return resIssues | ||
| }).WithLoadMode(goanalysis.LoadModeSyntax) | ||
| } | ||
|
|
||
| func checkFileForGlobals(f *ast.File, fset *token.FileSet) []result.Issue { | ||
| var res []result.Issue | ||
| for _, decl := range f.Decls { | ||
| genDecl, ok := decl.(*ast.GenDecl) | ||
| if !ok { | ||
| continue | ||
| } | ||
| if genDecl.Tok != token.VAR { | ||
| continue | ||
| } | ||
|
|
||
| for _, spec := range genDecl.Specs { | ||
| valueSpec := spec.(*ast.ValueSpec) | ||
| for _, vn := range valueSpec.Names { | ||
| if isWhitelisted(vn) { | ||
| continue | ||
| } | ||
|
|
||
| res = append(res, result.Issue{ | ||
| Pos: fset.Position(vn.Pos()), | ||
| Text: fmt.Sprintf("%s is a global variable", formatCode(vn.Name, nil)), | ||
| FromLinter: gochecknoglobalsName, | ||
| }) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return res | ||
| } | ||
|
|
||
| func isWhitelisted(i *ast.Ident) bool { | ||
| return i.Name == "_" || i.Name == "version" || looksLikeError(i) | ||
| } | ||
|
|
||
| // looksLikeError returns true if the AST identifier starts | ||
| // with 'err' or 'Err', or false otherwise. | ||
| // | ||
| // TODO: https://github.com/leighmcculloch/gochecknoglobals/issues/5 | ||
| func looksLikeError(i *ast.Ident) bool { | ||
| prefix := "err" | ||
| if i.IsExported() { | ||
| prefix = "Err" | ||
| } | ||
| return strings.HasPrefix(i.Name, prefix) | ||
| return goanalysis.NewLinter( | ||
| gochecknoglobals.Name, | ||
| gochecknoglobals.Doc, | ||
| []*analysis.Analyzer{gochecknoglobals}, | ||
| linterConfig, | ||
| ).WithLoadMode(goanalysis.LoadModeSyntax) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.