analysishelper

package

v0.0.0-...-f3f320c Latest Latest Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 3 Imported by: 10

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/uber-go/nilaway

Links

Open Source Insights

Documentation ¶

Overview ¶

Package analysishelper provides helper functions for the `go/analysis` package.

Index ¶

func WrapRun[T any](f func(*analysis.Pass) (T, error)) func(*analysis.Pass) (any, error)
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WrapRun ¶

func WrapRun[T any](f func(*analysis.Pass) (T, error)) func(*analysis.Pass) (any, error)

WrapRun wraps the run function of an analyzer to: (1) convert the return type to Result[T] and put the error in the Result[T].Err field in order to _not_ stop the analysis and let upper-level analyzer to decide what to do. (2) recover from a panic and convert it to an error with stack traces for easier debugging. This is to ensure that NilAway _never_ panics during the analysis. Moreover, it also wraps the error from the sub-analyzer with the name of the analyzer to make it easier to identify the source of the error.

Types ¶

type Result ¶

type Result[T any] struct {
	// Res is the actual result from the sub-analyzer.
	Res T
	// Err is the optional error from the sub-analyzer.
	Err error
}

Result is the result struct for the sub-analyzers where the actual result is accompanied by an optional error.

Source Files ¶

View all Source files

analyzer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL