goinspect

README

goinspect

individual inspection command

install

$ go install github.com/podhmo/goinspect/cmd/goinspect@latest

how to use

$ goinspect --pkg ./internal/x/... --only F --include-unexported
package github.com/podhmo/goinspect/internal/x

  func x.F(s x.S)
    func x.log() func()
    func x.F0()
      func x.log() func()
      func x.F1()
        func x.H()
    func x.H()

./internal/x/func.go

inspired by

• https://github.com/podhmo/pyinspect

Documentation

Index

• func Dump(w io.Writer, c *Config, g *Graph, nodes []*Node) error
• func DumpAll(w io.Writer, c *Config, g *Graph) error
• type Config
  • func (c *Config) NeedName(name string) bool
• type Graph
  • func Scan(c *Config, pkgs []*packages.Package) (*Graph, error)
• type Kind
• type Node
• type Scanner
  • func (s *Scanner) Scan(pkg *packages.Package, t *ast.File) error
• type Subject

Functions

func Dump

func Dump(w io.Writer, c *Config, g *Graph, nodes []*Node) error

func DumpAll

func DumpAll(w io.Writer, c *Config, g *Graph) error

Types

type Config

type Config struct {
	Fset *token.FileSet

	PkgPath    string
	Padding    string
	TrimPrefix string

	ExpandAll         bool
	IncludeUnexported bool
	OtherPackages     []string

	Debug bool
	// contains filtered or unexported fields
}

func (*Config) NeedName

func (c *Config) NeedName(name string) bool

type Graph

type Graph = graph.Graph[string, *Subject]

func Scan

func Scan(c *Config, pkgs []*packages.Package) (*Graph, error)

type Kind

type Kind string

const (
	KindFunc   Kind = "F"
	KindObject Kind = "O"
	KindMethod Kind = "M"
)

type Node

type Node = graph.Node[*Subject]

type Scanner

type Scanner struct {
	Config *Config
	// contains filtered or unexported fields
}

func (*Scanner) Scan

func (s *Scanner) Scan(pkg *packages.Package, t *ast.File) error

type Subject

type Subject struct {
	ID     string
	Object types.Object
	Recv   string // if method, this value is not zero
	Kind   Kind
}