1
0
mirror of https://github.com/mgechev/revive.git synced 2025-07-13 01:00:17 +02:00

Adds support for new type alias any in the rule redefines-built-in (#659)

* adds support for any type alias

* adds more representative tests
This commit is contained in:
chavacava
2022-03-29 10:51:01 +02:00
committed by GitHub
parent 5f6f0eb142
commit fa939adbf0
2 changed files with 121 additions and 75 deletions

View File

@ -8,21 +8,14 @@ import (
"github.com/mgechev/revive/lint" "github.com/mgechev/revive/lint"
) )
// RedefinesBuiltinIDRule warns when a builtin identifier is shadowed. var builtInConstAndVars = map[string]bool{
type RedefinesBuiltinIDRule struct{}
// Apply applies the rule to given file.
func (r *RedefinesBuiltinIDRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
var failures []lint.Failure
builtInConstAndVars := map[string]bool{
"true": true, "true": true,
"false": true, "false": true,
"iota": true, "iota": true,
"nil": true, "nil": true,
} }
builtFunctions := map[string]bool{ var builtFunctions = map[string]bool{
"append": true, "append": true,
"cap": true, "cap": true,
"close": true, "close": true,
@ -38,9 +31,9 @@ func (r *RedefinesBuiltinIDRule) Apply(file *lint.File, _ lint.Arguments) []lint
"println": true, "println": true,
"real": true, "real": true,
"recover": true, "recover": true,
} }
builtInTypes := map[string]bool{ var builtInTypes = map[string]bool{
"ComplexType": true, "ComplexType": true,
"FloatType": true, "FloatType": true,
"IntegerType": true, "IntegerType": true,
@ -66,14 +59,22 @@ func (r *RedefinesBuiltinIDRule) Apply(file *lint.File, _ lint.Arguments) []lint
"uint64": true, "uint64": true,
"uint8": true, "uint8": true,
"uintptr": true, "uintptr": true,
} "any": true,
}
// RedefinesBuiltinIDRule warns when a builtin identifier is shadowed.
type RedefinesBuiltinIDRule struct{}
// Apply applies the rule to given file.
func (r *RedefinesBuiltinIDRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
var failures []lint.Failure
onFailure := func(failure lint.Failure) { onFailure := func(failure lint.Failure) {
failures = append(failures, failure) failures = append(failures, failure)
} }
astFile := file.AST astFile := file.AST
w := &lintRedefinesBuiltinID{builtInConstAndVars, builtFunctions, builtInTypes, onFailure} w := &lintRedefinesBuiltinID{onFailure}
ast.Walk(w, astFile) ast.Walk(w, astFile)
return failures return failures
@ -85,34 +86,46 @@ func (r *RedefinesBuiltinIDRule) Name() string {
} }
type lintRedefinesBuiltinID struct { type lintRedefinesBuiltinID struct {
constsAndVars map[string]bool
funcs map[string]bool
types map[string]bool
onFailure func(lint.Failure) onFailure func(lint.Failure)
} }
func (w *lintRedefinesBuiltinID) Visit(node ast.Node) ast.Visitor { func (w *lintRedefinesBuiltinID) Visit(node ast.Node) ast.Visitor {
switch n := node.(type) { switch n := node.(type) {
case *ast.GenDecl: case *ast.GenDecl:
if n.Tok != token.TYPE { switch n.Tok {
return nil // skip if not type declaration case token.TYPE:
}
typeSpec, ok := n.Specs[0].(*ast.TypeSpec) typeSpec, ok := n.Specs[0].(*ast.TypeSpec)
if !ok { if !ok {
return nil return nil
} }
id := typeSpec.Name.Name id := typeSpec.Name.Name
if w.types[id] { if ok, bt := w.isBuiltIn(id); ok {
w.addFailure(n, fmt.Sprintf("redefinition of the built-in type %s", id)) w.addFailure(n, fmt.Sprintf("redefinition of the built-in %s %s", bt, id))
} }
case token.VAR, token.CONST:
for _, vs := range n.Specs {
valSpec, ok := vs.(*ast.ValueSpec)
if !ok {
continue
}
for _, name := range valSpec.Names {
if ok, bt := w.isBuiltIn(name.Name); ok {
w.addFailure(n, fmt.Sprintf("redefinition of the built-in %s %s", bt, name))
}
}
}
default:
return nil // skip if not type/var/const declaration
}
case *ast.FuncDecl: case *ast.FuncDecl:
if n.Recv != nil { if n.Recv != nil {
return w // skip methods return w // skip methods
} }
id := n.Name.Name id := n.Name.Name
if w.funcs[id] { if ok, bt := w.isBuiltIn(id); ok {
w.addFailure(n, fmt.Sprintf("redefinition of the built-in function %s", id)) w.addFailure(n, fmt.Sprintf("redefinition of the built-in %s %s", bt, id))
} }
case *ast.AssignStmt: case *ast.AssignStmt:
for _, e := range n.Lhs { for _, e := range n.Lhs {
@ -121,13 +134,20 @@ func (w *lintRedefinesBuiltinID) Visit(node ast.Node) ast.Visitor {
continue continue
} }
if w.constsAndVars[id.Name] { if ok, bt := w.isBuiltIn(id.Name); ok {
var msg string var msg string
println(bt, id.Name)
switch bt {
case "constant or variable":
if n.Tok == token.DEFINE { if n.Tok == token.DEFINE {
msg = fmt.Sprintf("assignment creates a shadow of built-in identifier %s", id.Name) msg = fmt.Sprintf("assignment creates a shadow of built-in identifier %s", id.Name)
} else { } else {
msg = fmt.Sprintf("assignment modifies built-in identifier %s", id.Name) msg = fmt.Sprintf("assignment modifies built-in identifier %s", id.Name)
} }
default:
msg = fmt.Sprintf("redefinition of the built-in %s %s", bt, id)
}
w.addFailure(n, msg) w.addFailure(n, msg)
} }
} }
@ -144,3 +164,19 @@ func (w lintRedefinesBuiltinID) addFailure(node ast.Node, msg string) {
Failure: msg, Failure: msg,
}) })
} }
func (w lintRedefinesBuiltinID) isBuiltIn(id string) (r bool, builtInKind string) {
if builtFunctions[id] {
return true, "function"
}
if builtInConstAndVars[id] {
return true, "constant or variable"
}
if builtInTypes[id] {
return true, "type"
}
return false, ""
}

View File

@ -19,3 +19,13 @@ func delete(set []int64, i int) (y []int64) { // MATCH /redefinition of the buil
} }
return return
} }
type any int // MATCH /redefinition of the built-in type any/
func any() {} // MATCH /redefinition of the built-in type any/
var any int // MATCH /redefinition of the built-in type any/
const any = 1 // MATCH /redefinition of the built-in type any/
var i, copy int // MATCH /redefinition of the built-in function copy/