Skip to content

refactor: simplifies the implementation of rule call-to-gc #1388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2025
Merged

refactor: simplifies the implementation of rule call-to-gc #1388

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
511f36f
refactor: simplifies the implementation of rule call-to-gc
chavacava May 27, 2025
0d3adda
remove unused struct field
chavacava May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions rule/call_to_gc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package rule
import (
"go/ast"

"github.com/mgechev/revive/internal/astutils"
"github.com/mgechev/revive/lint"
)

Expand All @@ -16,11 +17,7 @@ func (*CallToGCRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
failures = append(failures, failure)
}

gcTriggeringFunctions := map[string]map[string]bool{
"runtime": {"GC": true},
}

w := lintCallToGC{onFailure, gcTriggeringFunctions}
w := lintCallToGC{onFailure}
ast.Walk(w, file.AST)

return failures
Expand All @@ -32,31 +29,17 @@ func (*CallToGCRule) Name() string {
}

type lintCallToGC struct {
onFailure func(lint.Failure)
gcTriggeringFunctions map[string]map[string]bool
onFailure func(lint.Failure)
}

func (w lintCallToGC) Visit(node ast.Node) ast.Visitor {
ce, ok := node.(*ast.CallExpr)
if !ok {
return w // nothing to do, the node is not a call
}

fc, ok := ce.Fun.(*ast.SelectorExpr)
if !ok {
return nil // nothing to do, the call is not of the form pkg.func(...)
}

id, ok := fc.X.(*ast.Ident)

if !ok {
return nil // in case X is not an id (it should be!)
return w // nothing to do, the node is not a function call
}

fn := fc.Sel.Name
pkg := id.Name
if !w.gcTriggeringFunctions[pkg][fn] {
return nil // it isn't a call to a GC triggering function
if !astutils.IsPkgDotName(ce.Fun, "runtime", "GC") {
return nil // nothing to do, the call is not a call to the Garbage Collector
}

w.onFailure(lint.Failure{
Expand Down