inspect

Documentation

Overview

Package inspect defines an Analyzer that provides an AST inspector (github.com/block/ftl-golang-tools/go/ast/inspector.Inspector) for the syntax trees of a package. It is only a building block for other analyzers.

Example of use in another analysis:

import (
	"github.com/block/ftl-golang-tools/go/analysis"
	"github.com/block/ftl-golang-tools/go/analysis/passes/inspect"
	"github.com/block/ftl-golang-tools/go/ast/inspector"
)

var Analyzer = &analysis.Analyzer{
	...
	Requires:       []*analysis.Analyzer{inspect.Analyzer},
}

func run(pass *analysis.Pass) (interface{}, error) {
	inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
	inspect.Preorder(nil, func(n ast.Node) {
		...
	})
	return nil, nil
}

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:             "inspect",
	Doc:              "optimize AST traversal for later passes",
	URL:              "https://pkg.go.dev/github.com/block/ftl-golang-tools/go/analysis/passes/inspect",
	Run:              run,
	RunDespiteErrors: true,
	ResultType:       reflect.TypeOf(new(inspector.Inspector)),
}