analysisutil

Documentation

Overview

Package analysisutil contains functions common for `analyzer` and `internal/checkers` packages. In addition, it is intended to "lighten" these packages.

If the function is common to several packages, or it makes sense to test it separately without "polluting" the target package with tests of private functionality, then you can put function in this package.

It's important to avoid dependency on `golang.org/x/tools/go/analysis` in the helpers API. This makes the API "narrower" and also allows you to test functions without some "abstraction leaks".

Index

• func Imports(file *ast.File, pkgs ...string) bool
• func IsJSONLike(s string) bool
• func IsObj(typesInfo *types.Info, expr ast.Expr, expected types.Object) bool
• func IsPkg(pkg *types.Package, name, path string) bool
• func NodeBytes(fset *token.FileSet, node ast.Node) []byte
• func NodeString(fset *token.FileSet, node ast.Node) string
• func ObjectOf(pkg *types.Package, objPkg, objName string) types.Object

Functions

func Imports

func Imports(file *ast.File, pkgs ...string) bool

Imports tells if the file imports at least one of the packages. If no packages provided then function returns false.

func IsJSONLike

func IsJSONLike(s string) bool

IsJSONLike returns true if the string has JSON format features. A positive result can be returned for invalid JSON as well.

func IsObj

func IsObj(typesInfo *types.Info, expr ast.Expr, expected types.Object) bool

IsObj returns true if expression is identifier which notes to given types.Object. Useful in combination with types.Universe objects.

func IsPkg

func IsPkg(pkg *types.Package, name, path string) bool

IsPkg checks that package has corresponding objName and path. Supports vendored packages.

func NodeBytes

func NodeBytes(fset *token.FileSet, node ast.Node) []byte

NodeBytes works as NodeString but returns a byte slice. Return nil if node AST is invalid.

func NodeString

func NodeString(fset *token.FileSet, node ast.Node) string

NodeString is a more powerful analogue of types.ExprString. Return empty string if node AST is invalid.

func ObjectOf

func ObjectOf(pkg *types.Package, objPkg, objName string) types.Object

ObjectOf works in context of Golang package and returns types.Object for the given object's package and name. The search is based on the provided package and its dependencies (imports). Returns nil if the object is not found.