-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build(deps): bump github.com/alexkohler/nakedret to 2.0.1 (#3760)
- Loading branch information
1 parent
252ae9f
commit 8f8c68a
Showing
4 changed files
with
17 additions
and
117 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,134 +1,27 @@ | ||
package golinters | ||
|
||
import ( | ||
"fmt" | ||
"go/ast" | ||
"go/token" | ||
"sync" | ||
|
||
"github.com/alexkohler/nakedret/v2" | ||
"golang.org/x/tools/go/analysis" | ||
|
||
"github.com/golangci/golangci-lint/pkg/config" | ||
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis" | ||
"github.com/golangci/golangci-lint/pkg/lint/linter" | ||
"github.com/golangci/golangci-lint/pkg/result" | ||
) | ||
|
||
const nakedretName = "nakedret" | ||
|
||
//nolint:dupl | ||
func NewNakedret(settings *config.NakedretSettings) *goanalysis.Linter { | ||
var mu sync.Mutex | ||
var resIssues []goanalysis.Issue | ||
|
||
analyzer := &analysis.Analyzer{ | ||
Name: nakedretName, | ||
Doc: goanalysis.TheOnlyanalyzerDoc, | ||
Run: func(pass *analysis.Pass) (any, error) { | ||
issues := runNakedRet(pass, settings) | ||
|
||
if len(issues) == 0 { | ||
return nil, nil | ||
} | ||
|
||
mu.Lock() | ||
resIssues = append(resIssues, issues...) | ||
mu.Unlock() | ||
|
||
return nil, nil | ||
}, | ||
var maxLines int | ||
if settings != nil { | ||
maxLines = settings.MaxFuncLines | ||
} | ||
|
||
analyzer := nakedret.NakedReturnAnalyzer(uint(maxLines)) | ||
|
||
return goanalysis.NewLinter( | ||
nakedretName, | ||
"Finds naked returns in functions greater than a specified function length", | ||
[]*analysis.Analyzer{analyzer}, | ||
nil, | ||
).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue { | ||
return resIssues | ||
}).WithLoadMode(goanalysis.LoadModeSyntax) | ||
} | ||
|
||
func runNakedRet(pass *analysis.Pass, settings *config.NakedretSettings) []goanalysis.Issue { | ||
var issues []goanalysis.Issue | ||
|
||
for _, file := range pass.Files { | ||
v := nakedretVisitor{ | ||
maxLength: settings.MaxFuncLines, | ||
f: pass.Fset, | ||
} | ||
|
||
ast.Walk(&v, file) | ||
|
||
for i := range v.issues { | ||
issues = append(issues, goanalysis.NewIssue(&v.issues[i], pass)) | ||
} | ||
} | ||
|
||
return issues | ||
} | ||
|
||
type nakedretVisitor struct { | ||
maxLength int | ||
f *token.FileSet | ||
issues []result.Issue | ||
} | ||
|
||
func (v *nakedretVisitor) processFuncDecl(funcDecl *ast.FuncDecl) { | ||
file := v.f.File(funcDecl.Pos()) | ||
functionLineLength := file.Position(funcDecl.End()).Line - file.Position(funcDecl.Pos()).Line | ||
|
||
// Scan the body for usage of the named returns | ||
for _, stmt := range funcDecl.Body.List { | ||
s, ok := stmt.(*ast.ReturnStmt) | ||
if !ok { | ||
continue | ||
} | ||
|
||
if len(s.Results) != 0 { | ||
continue | ||
} | ||
|
||
file := v.f.File(s.Pos()) | ||
if file == nil || functionLineLength <= v.maxLength { | ||
continue | ||
} | ||
if funcDecl.Name == nil { | ||
continue | ||
} | ||
|
||
v.issues = append(v.issues, result.Issue{ | ||
FromLinter: nakedretName, | ||
Text: fmt.Sprintf("naked return in func `%s` with %d lines of code", | ||
funcDecl.Name.Name, functionLineLength), | ||
Pos: v.f.Position(s.Pos()), | ||
}) | ||
} | ||
} | ||
|
||
func (v *nakedretVisitor) Visit(node ast.Node) ast.Visitor { | ||
funcDecl, ok := node.(*ast.FuncDecl) | ||
if !ok { | ||
return v | ||
} | ||
|
||
var namedReturns []*ast.Ident | ||
|
||
// We've found a function | ||
if funcDecl.Type != nil && funcDecl.Type.Results != nil { | ||
for _, field := range funcDecl.Type.Results.List { | ||
for _, ident := range field.Names { | ||
if ident != nil { | ||
namedReturns = append(namedReturns, ident) | ||
} | ||
} | ||
} | ||
} | ||
|
||
if len(namedReturns) == 0 || funcDecl.Body == nil { | ||
return v | ||
} | ||
|
||
v.processFuncDecl(funcDecl) | ||
return v | ||
).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