engine

Documentation

Overview

Package engine runs the shared contract/rule engine across Go packages.

Index

• type Options
• type Result
  • func Analyze(ctx context.Context, patterns []string, cfg config.Config) (Result, error)
  • func AnalyzeWithOptions(ctx context.Context, patterns []string, cfg config.Config, options Options) (Result, error)

Types

type Options

type Options struct {
	Dir       string
	BuildTags []string
}

type Result

type Result struct {
	FileSet       *token.FileSet
	Diagnostics   []rules.Diagnostic
	Contracts     []*contract.StructContract
	ModulePath    string
	ModuleDir     string
	ModuleVersion string
	GoVersion     string
}

Result contains deterministic diagnostics and the source position table.

func Analyze

func Analyze(ctx context.Context, patterns []string, cfg config.Config) (Result, error)

Analyze loads package patterns and evaluates every discovered struct.

func AnalyzeWithOptions

func AnalyzeWithOptions(ctx context.Context, patterns []string, cfg config.Config, options Options) (Result, error)

AnalyzeWithOptions supports isolated worktrees and explicit build tags.