yze

README

yze

The aggregator for the gomatic yze analyzer family: it fans in every yze-<group>-<name> analyzer and runs them over Go packages through the go-yze driver, emitting a normalized report.

yze [--format stickler-json|text] [--fix] [--group <g>] [--category <c>...] [packages...]

• --format stickler-json (default) — the native Report JSON the stickler runner consumes with no adapter. text prints one human line per finding.
• --fix — applies analyzers' suggested fixes in place via the shared go-yze engine.
• --group / --category — restrict the analyzer set. group is the stable name-segment axis (default go); category is the many-to-many tag axis.

Findings do not by themselves fail the run — that gate belongs to stickler. The current suite: yze-go-errconst, yze-go-gotostmt, yze-go-namedtypes.

Documentation

Overview

Package yze is the analyzer catalog for the yze family: it aggregates every yze-<group>-<name> analyzer's registration and filters the set by group and 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 Filter(regs []goyze.Registration, group goyze.Group, categories []goyze.Category) []goyze.Registration
• func Registrations() []goyze.Registration
• type Format

Constants

const ErrUnknownFormat errs.Const = "unknown output format"

ErrUnknownFormat reports an output 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 Filter

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

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

func Registrations

func Registrations() []goyze.Registration

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

Types

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.