revive/rule/import_shadowing.go

package rule

import (
	"fmt"
	"go/ast"
	"go/token"
	"strings"

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

// ImportShadowingRule spots identifiers that shadow an import.
type ImportShadowingRule struct{}

// Apply applies the rule to given file.
func (*ImportShadowingRule) Apply(file *lint.File, _ lint.Arguments) []lint.Failure {
	var failures []lint.Failure

	importNames := map[string]struct{}{}
	for _, imp := range file.AST.Imports {
		importNames[getName(imp)] = struct{}{}
	}

	fileAst := file.AST
	walker := importShadowing{
		packageNameIdent: fileAst.Name,
		importNames:      importNames,
		onFailure: func(failure lint.Failure) {
			failures = append(failures, failure)
		},
		alreadySeen: map[*ast.Object]struct{}{},
		skipIdents:  map[*ast.Ident]struct{}{},
	}

	ast.Walk(walker, fileAst)

	return failures
}

// Name returns the rule name.
func (*ImportShadowingRule) Name() string {
	return "import-shadowing"
}

func getName(imp *ast.ImportSpec) string {
	const pathSep = "/"
	const strDelim = `"`
	if imp.Name != nil {
		return imp.Name.Name
	}

	path := imp.Path.Value
	i := strings.LastIndex(path, pathSep)
	if i == -1 {
		return strings.Trim(path, strDelim)
	}

	return strings.Trim(path[i+1:], strDelim)
}

type importShadowing struct {
	packageNameIdent *ast.Ident
	importNames      map[string]struct{}
	onFailure        func(lint.Failure)
	alreadySeen      map[*ast.Object]struct{}
	skipIdents       map[*ast.Ident]struct{}
}

// Visit visits AST nodes and checks if id nodes (ast.Ident) shadow an import name
func (w importShadowing) Visit(n ast.Node) ast.Visitor {
	switch n := n.(type) {
	case *ast.AssignStmt:
		if n.Tok == token.DEFINE {
			return w // analyze variable declarations of the form id := expr
		}

		return nil // skip assigns of the form id = expr (not an id declaration)
	case *ast.CallExpr, // skip call expressions (not an id declaration)
		*ast.ImportSpec,   // skip import section subtree because we already have the list of imports
		*ast.KeyValueExpr, // skip analysis of key-val expressions ({key:value}): ids of such expressions, even the same of an import name, do not shadow the import name
		*ast.ReturnStmt,   // skip skipping analysis of returns, ids in expression were already analyzed
		*ast.SelectorExpr, // skip analysis of selector expressions (anId.otherId): because if anId shadows an import name, it was already detected, and otherId does not shadows the import name
		*ast.StructType:   // skip analysis of struct type because struct fields can not shadow an import name
		return nil
	case *ast.FuncDecl:
		if n.Recv != nil {
			w.skipIdents[n.Name] = struct{}{}
		}
	case *ast.Ident:
		if n == w.packageNameIdent {
			return nil // skip the ident corresponding to the package name of this file
		}

		id := n.Name
		if id == "_" {
			return w // skip _ id
		}

		_, isImportName := w.importNames[id]
		_, alreadySeen := w.alreadySeen[n.Obj]
		_, skipIdent := w.skipIdents[n]
		if isImportName && !alreadySeen && !skipIdent {
			w.onFailure(lint.Failure{
				Confidence: 1,
				Node:       n,
				Category:   "naming",
				Failure:    fmt.Sprintf("The name '%s' shadows an import name", id),
			})

			w.alreadySeen[n.Obj] = struct{}{}
		}
	}

	return w
}