golangci-lint/vendor/github.com/tommy-muehle/go-mnd/checks/argument.go

package checks

import (
	"go/ast"

	"golang.org/x/tools/go/analysis"
)

const ArgumentCheck = "argument"

// Known excludes for the argument check.
var argumentExcludes = map[string]string{
	// package: function
	"time": "Date", // https://golang.org/pkg/time/#Date
}

type ArgumentAnalyzer struct {
	pass *analysis.Pass
}

func NewArgumentAnalyzer(pass *analysis.Pass) *ArgumentAnalyzer {
	return &ArgumentAnalyzer{
		pass: pass,
	}
}

func (a *ArgumentAnalyzer) NodeFilter() []ast.Node {
	return []ast.Node{
		(*ast.CallExpr)(nil),
	}
}

func (a *ArgumentAnalyzer) Check(n ast.Node) {
	expr, ok := n.(*ast.CallExpr)
	if !ok {
		return
	}

	// Don't check if package and function combination is excluded
	if s, ok := expr.Fun.(*ast.SelectorExpr); ok && a.isExcluded(s) {
		return
	}

	for i, arg := range expr.Args {
		switch x := arg.(type) {
		case *ast.BasicLit:
			if !isMagicNumber(x) {
				continue
			}
			// If it's a magic number and has no previous element, report it
			if i == 0 {
				a.pass.Reportf(x.Pos(), reportMsg, x.Value, ArgumentCheck)
			} else {
				// Otherwise check the previous element type
				switch expr.Args[i-1].(type) {
				case *ast.ChanType:
					// When it's not a simple buffered channel, report it
					if x.Value != "1" {
						a.pass.Reportf(x.Pos(), reportMsg, x.Value, ArgumentCheck)
					}
				}
			}
		case *ast.BinaryExpr:
			a.checkBinaryExpr(x)
		}
	}
}

func (a *ArgumentAnalyzer) isExcluded(expr *ast.SelectorExpr) bool {
	var p string

	switch x := expr.X.(type) {
	case *ast.Ident:
		p = x.Name
	}

	if v, ok := argumentExcludes[p]; ok && v == expr.Sel.Name {
		return true
	}

	return false
}

func (a *ArgumentAnalyzer) checkBinaryExpr(expr *ast.BinaryExpr) {
	switch x := expr.X.(type) {
	case *ast.BasicLit:
		if isMagicNumber(x) {
			a.pass.Reportf(x.Pos(), reportMsg, x.Value, ArgumentCheck)
		}
	}

	switch y := expr.Y.(type) {
	case *ast.BasicLit:
		if isMagicNumber(y) {
			a.pass.Reportf(y.Pos(), reportMsg, y.Value, ArgumentCheck)
		}
	}
}