yze

README

docs

Documentation

Overview

Package yze is the analyzer catalog for the yze family: it aggregates every yze-<name> analyzer's registration and filters the set by category. The cmd/yze binary drives this catalog through the go-yze runner.

Index

• Constants
• func Emit(w io.Writer, format Format, report goyze.Report) error
• func EmitRules(w io.Writer, format RuleFormat, regs []goyze.Registration) error
• func Filter(regs []goyze.Registration, categories []goyze.Category) []goyze.Registration
• func LoadConfig(read func(path string) ([]byte, error), path ConfigPath) (goyze.Settings, error)
• func Registrations() []goyze.Registration
• func RootsOf(patterns []goyze.Pattern) []string
• func RunSQL(read goyze.FileReader, walk WalkDir, analyzers []SQLAnalyzer, roots []string) (goyze.Report, error)
• type ConfigPath
• type Format
• type RuleFormat
• type SQLAnalyzer
  • func FilterSQL(analyzers []SQLAnalyzer, categories []goyze.Category) []SQLAnalyzer
  • func SQLAnalyzers() []SQLAnalyzer
• type WalkDir

Constants

const (
	// ErrSQLWalk reports that walking a root for .sql files failed.
	ErrSQLWalk errs.Const = "cannot walk for SQL files"
	// ErrSQLRead reports that a .sql file could not be read.
	ErrSQLRead errs.Const = "cannot read SQL file"
)

SQL run errors.

const ErrConfig errs.Const = "cannot load yze config"

ErrConfig reports a yze configuration file that cannot be read or parsed.

const ErrUnknownFormat errs.Const = "unknown output format"

ErrUnknownFormat reports an output format the aggregator does not support.

const ErrUnknownRuleFormat errs.Const = "unknown rule-export format"

ErrUnknownRuleFormat reports a rule-export format the aggregator does not support.

Functions

func Emit

func Emit(w io.Writer, format Format, report goyze.Report) error

Emit writes the report to w in the named format.

func EmitRules

func EmitRules(w io.Writer, format RuleFormat, regs []goyze.Registration) error

EmitRules writes the suite's rule catalog to w in the named format.

func Filter

func Filter(regs []goyze.Registration, categories []goyze.Category) []goyze.Registration

Filter selects the registrations matching the given categories. An empty category set matches every analyzer; otherwise a registration matches when it carries any of the categories.

func LoadConfig

func LoadConfig(read func(path string) ([]byte, error), path ConfigPath) (goyze.Settings, error)

func Registrations

func Registrations() []goyze.Registration

Registrations returns every analyzer in the suite, in stable rule-id order.

func RootsOf

func RootsOf(patterns []goyze.Pattern) []string

RootsOf turns package patterns into the directories to walk for .sql files: the recursive "/..." suffix is dropped, and a bare or empty pattern becomes ".".

func RunSQL

func RunSQL(read goyze.FileReader, walk WalkDir, analyzers []SQLAnalyzer, roots []string) (goyze.Report, error)

RunSQL finds every .sql file under the roots and runs the analyzers over each, returning the merged diagnostics. A walk or read failure aborts the run.

Types

type ConfigPath

type ConfigPath string

LoadConfig reads and parses a yze config file into per-analyzer settings keyed by analyzer name then setting name, ready for go-yze's ApplyConfig. The reader is injected so callers control filesystem access. ConfigPath is the path to a yze per-analyzer config file.

type Format

type Format string

Format names a way the aggregator serializes a report.

const (
	FormatSticklerJSON Format = "stickler-json"
	FormatText         Format = "text"
)

The output formats cmd/yze supports. Richer formats (sarif, github) live in the stickler runner, which consumes the stickler-json emitted here.

type RuleFormat

type RuleFormat string

RuleFormat names a way the suite's rule catalog is exported. The catalog is built from registration metadata (id, name, doc, url, categories) — never from analyzer logic — so it carries no per-analyzer machinery.

const (
	// RuleFormatSARIF exports a SARIF 2.1.0 tool.driver.rules catalog for code
	// scanning / editor rule registration.
	RuleFormatSARIF RuleFormat = "sarif"
	// RuleFormatGrit exports a GritQL-style markdown registry. The analyzers are
	// AST-based, not pattern rewrites, so this is a documentation catalog (rule id,
	// description, docs link, categories) — not executable rewrite patterns.
	RuleFormatGrit RuleFormat = "grit"
)

The rule-export formats `yze --emit-rules` supports.

type SQLAnalyzer

type SQLAnalyzer struct {
	Analyze    func(path, source string) ([]goyze.Diagnostic, error)
	Name       goyze.AnalyzerName
	Categories []goyze.Category
}

SQLAnalyzer is a source analyzer the suite runs over .sql files, as opposed to the go/analysis analyzers it runs over Go packages. Its diagnostics already use the shared go-yze contract, so they merge into the same report.

func FilterSQL

func FilterSQL(analyzers []SQLAnalyzer, categories []goyze.Category) []SQLAnalyzer

FilterSQL selects the SQL analyzers matching the given categories, mirroring Filter. An empty category set matches every analyzer.

func SQLAnalyzers

func SQLAnalyzers() []SQLAnalyzer

SQLAnalyzers returns every SQL source analyzer bundled into the suite, in stable rule-id order.

type WalkDir

type WalkDir func(root string, fn fs.WalkDirFunc) error

WalkDir is fs.WalkDir's signature. It's injected so a test can drive the file walk without a real directory tree.