generated

Documentation

Overview

Package generated defines an analyzer whose result makes it convenient to skip diagnostics within generated files.

Index

• Variables
• type Result
  • func (r *Result) IsGenerated(pos token.Pos) bool

Variables

var Analyzer = &analysis.Analyzer{
	Name:       "generated",
	Doc:        "detect which Go files are generated",
	URL:        "https://pkg.go.dev/golang.org/x/tools/internal/analysisinternal/generated",
	ResultType: reflect.TypeOf((*Result)(nil)),
	Run: func(pass *analysis.Pass) (any, error) {
		set := make(map[*token.File]bool)
		for _, file := range pass.Files {
			if ast.IsGenerated(file) {
				set[pass.Fset.File(file.FileStart)] = true
			}
		}
		return &Result{fset: pass.Fset, generatedFiles: set}, nil
	},
}

Types

type Result

type Result struct {
	// contains filtered or unexported fields
}

func (*Result) IsGenerated

func (r *Result) IsGenerated(pos token.Pos) bool

IsGenerated reports whether the position is within a generated file.