mirror of
https://github.com/mgechev/revive.git
synced 2024-12-04 10:24:49 +02:00
111 lines
2.4 KiB
Go
111 lines
2.4 KiB
Go
package rule
|
|
|
|
import (
|
|
"fmt"
|
|
"go/ast"
|
|
"strings"
|
|
"unicode"
|
|
"unicode/utf8"
|
|
|
|
"github.com/mgechev/revive/lint"
|
|
)
|
|
|
|
// DeepExitRule lints program exit at functions other than main or init.
|
|
type DeepExitRule struct{}
|
|
|
|
// Apply applies the rule to given file.
|
|
func (*DeepExitRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
|
|
var failures []lint.Failure
|
|
onFailure := func(failure lint.Failure) {
|
|
failures = append(failures, failure)
|
|
}
|
|
|
|
w := &lintDeepExit{onFailure: onFailure, isTestFile: file.IsTest()}
|
|
ast.Walk(w, file.AST)
|
|
return failures
|
|
}
|
|
|
|
// Name returns the rule name.
|
|
func (*DeepExitRule) Name() string {
|
|
return "deep-exit"
|
|
}
|
|
|
|
type lintDeepExit struct {
|
|
onFailure func(lint.Failure)
|
|
isTestFile bool
|
|
}
|
|
|
|
func (w *lintDeepExit) Visit(node ast.Node) ast.Visitor {
|
|
if fd, ok := node.(*ast.FuncDecl); ok {
|
|
if w.mustIgnore(fd) {
|
|
return nil // skip analysis of this function
|
|
}
|
|
|
|
return w
|
|
}
|
|
|
|
se, ok := node.(*ast.ExprStmt)
|
|
if !ok {
|
|
return w
|
|
}
|
|
ce, ok := se.X.(*ast.CallExpr)
|
|
if !ok {
|
|
return w
|
|
}
|
|
|
|
fc, ok := ce.Fun.(*ast.SelectorExpr)
|
|
if !ok {
|
|
return w
|
|
}
|
|
id, ok := fc.X.(*ast.Ident)
|
|
if !ok {
|
|
return w
|
|
}
|
|
|
|
pkg := id.Name
|
|
fn := fc.Sel.Name
|
|
if isCallToExitFunction(pkg, fn) {
|
|
w.onFailure(lint.Failure{
|
|
Confidence: 1,
|
|
Node: ce,
|
|
Category: "bad practice",
|
|
Failure: fmt.Sprintf("calls to %s.%s only in main() or init() functions", pkg, fn),
|
|
})
|
|
}
|
|
|
|
return w
|
|
}
|
|
|
|
func (w *lintDeepExit) mustIgnore(fd *ast.FuncDecl) bool {
|
|
fn := fd.Name.Name
|
|
|
|
return fn == "init" || fn == "main" || w.isTestMain(fd) || w.isTestExample(fd)
|
|
}
|
|
|
|
func (w *lintDeepExit) isTestMain(fd *ast.FuncDecl) bool {
|
|
return w.isTestFile && fd.Name.Name == "TestMain"
|
|
}
|
|
|
|
// isTestExample returns true if the function is a testable example function.
|
|
// See https://go.dev/blog/examples#examples-are-tests for more information.
|
|
//
|
|
// Inspired by https://github.com/golang/go/blob/go1.23.0/src/go/doc/example.go#L72-L77
|
|
func (w *lintDeepExit) isTestExample(fd *ast.FuncDecl) bool {
|
|
if !w.isTestFile {
|
|
return false
|
|
}
|
|
name := fd.Name.Name
|
|
const prefix = "Example"
|
|
if !strings.HasPrefix(name, prefix) {
|
|
return false
|
|
}
|
|
if len(name) == len(prefix) { // "Example" is a package level example
|
|
return len(fd.Type.Params.List) == 0
|
|
}
|
|
r, _ := utf8.DecodeRuneInString(name[len(prefix):])
|
|
if unicode.IsLower(r) {
|
|
return false
|
|
}
|
|
return len(fd.Type.Params.List) == 0
|
|
}
|