12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- package rule
-
- import (
- "fmt"
- "go/ast"
- "strings"
-
- "github.com/mgechev/revive/lint"
- )
-
- // GetReturnRule lints given else constructs.
- type GetReturnRule struct{}
-
- // Apply applies the rule to given file.
- func (r *GetReturnRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
- var failures []lint.Failure
-
- onFailure := func(failure lint.Failure) {
- failures = append(failures, failure)
- }
-
- w := lintReturnRule{onFailure}
- ast.Walk(w, file.AST)
- return failures
- }
-
- // Name returns the rule name.
- func (r *GetReturnRule) Name() string {
- return "get-return"
- }
-
- type lintReturnRule struct {
- onFailure func(lint.Failure)
- }
-
- func isGetter(name string) bool {
- if strings.HasPrefix(strings.ToUpper(name), "GET") {
- if len(name) > 3 {
- c := name[3]
- return !(c >= 'a' && c <= 'z')
- }
- }
-
- return false
- }
-
- func hasResults(rs *ast.FieldList) bool {
- return rs != nil && len(rs.List) > 0
- }
-
- func (w lintReturnRule) Visit(node ast.Node) ast.Visitor {
- fd, ok := node.(*ast.FuncDecl)
- if !ok {
- return w
- }
-
- if !isGetter(fd.Name.Name) {
- return w
- }
- if !hasResults(fd.Type.Results) {
- w.onFailure(lint.Failure{
- Confidence: 0.8,
- Node: fd,
- Category: "logic",
- Failure: fmt.Sprintf("function '%s' seems to be a getter but it does not return any result", fd.Name.Name),
- })
- }
-
- return w
- }
|