1
0
mirror of https://github.com/mgechev/revive.git synced 2025-11-25 22:12:38 +02:00

refactor (rule/flag-param): replace AST walker by iteration over declarations (#1164)

This commit is contained in:
chavacava
2024-12-04 20:55:01 +01:00
committed by GitHub
parent 9a5c95f1cf
commit fcfd6ad5f1

View File

@@ -13,13 +13,36 @@ type FlagParamRule struct{}
// Apply applies the rule to given file.
func (*FlagParamRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
var failures []lint.Failure
onFailure := func(failure lint.Failure) {
failures = append(failures, failure)
}
w := lintFlagParamRule{onFailure: onFailure}
ast.Walk(w, file.AST)
for _, decl := range file.AST.Decls {
fd, ok := decl.(*ast.FuncDecl)
isFuncWithNonEmptyBody := ok && fd.Body != nil
if !isFuncWithNonEmptyBody {
continue
}
boolParams := map[string]struct{}{}
for _, param := range fd.Type.Params.List {
if !isIdent(param.Type, "bool") {
continue
}
for _, paramIdent := range param.Names {
boolParams[paramIdent.Name] = struct{}{}
}
}
if len(boolParams) == 0 {
continue
}
cv := conditionVisitor{boolParams, fd, onFailure}
ast.Walk(cv, fd.Body)
}
return failures
}
@@ -28,43 +51,10 @@ func (*FlagParamRule) Name() string {
return "flag-parameter"
}
type lintFlagParamRule struct {
onFailure func(lint.Failure)
}
func (w lintFlagParamRule) Visit(node ast.Node) ast.Visitor {
fd, ok := node.(*ast.FuncDecl)
if !ok {
return w
}
if fd.Body == nil {
return nil // skip whole function declaration
}
for _, p := range fd.Type.Params.List {
t := p.Type
id, ok := t.(*ast.Ident)
if !ok {
continue
}
if id.Name != "bool" {
continue
}
cv := conditionVisitor{p.Names, fd, w}
ast.Walk(cv, fd.Body)
}
return w
}
type conditionVisitor struct {
ids []*ast.Ident
fd *ast.FuncDecl
linter lintFlagParamRule
idents map[string]struct{}
fd *ast.FuncDecl
onFailure func(lint.Failure)
}
func (w conditionVisitor) Visit(node ast.Node) ast.Visitor {
@@ -73,28 +63,22 @@ func (w conditionVisitor) Visit(node ast.Node) ast.Visitor {
return w
}
fselect := func(n ast.Node) bool {
findUsesOfIdents := func(n ast.Node) bool {
ident, ok := n.(*ast.Ident)
if !ok {
return false
}
for _, id := range w.ids {
if ident.Name == id.Name {
return true
}
}
return false
return w.idents[ident.Name] == struct{}{}
}
uses := pick(ifStmt.Cond, fselect)
uses := pick(ifStmt.Cond, findUsesOfIdents)
if len(uses) < 1 {
return w
}
w.linter.onFailure(lint.Failure{
w.onFailure(lint.Failure{
Confidence: 1,
Node: w.fd.Type.Params,
Category: "bad practice",