stickler

README

stickler

The gomatic lint runner — a stickler for the rules. It executes a set of analyzer tools (the yze suite, golangci-lint, and others) to completion, normalizes their findings into one diagnostic schema, writes the report to stdout in the chosen format, prints a pass/fail status to stderr, and reports pass/fail via the process exit code. Any finding or any tool error is a stickler failure; every tool still runs to completion first.

stickler [--format human|json|github] [root]

• Runner model — each tool is an executable plus an output adapter (Runner). yze is read via its native stickler-json (no adapter); golangci-lint's JSON is adapted. New tools are added as more Runners.
• --format — human (default, one line per finding), json (the normalized result), github (Actions annotations). SARIF output is planned.
• Exit code — 0 only when every tool ran cleanly with zero findings; non-zero on any finding or tool error.

Built on the go-yze diagnostic schema. --fix (delegating to each tool's fixer) and a stickler.yaml tool configuration are planned; v1 runs yze + golangci-lint zero-config.

Documentation

Overview

Package stickler is the gomatic lint runner: it executes a set of analyzer tools (the yze suite, golangci-lint, and others) to completion, normalizes their findings into one diagnostic schema, and reports pass/fail via the process exit code. Any finding or any tool error is a stickler failure.

Index

• Constants
• func ExecCommand(ctx context.Context, name string, args ...string) ([]byte, error)
• func Format(w io.Writer, format OutputFormat, result Result) error
• type Command
• type OutputFormat
• type Result
  • func Orchestrate(ctx context.Context, root string, runners []Runner) Result
  • func (r Result) Failed() bool
• type Runner
  • func NewGolangciRunner(command Command) Runner
  • func NewYzeRunner(command Command) Runner

Constants

const (
	// ErrYzeFailed reports that the yze aggregator could not be run or parsed.
	ErrYzeFailed errs.Const = "yze runner failed"
	// ErrGolangciFailed reports that golangci-lint could not be run or parsed.
	ErrGolangciFailed errs.Const = "golangci-lint runner failed"
)

Runner failures.

const ErrRunner errs.Const = "lint runner failed"

ErrRunner wraps a failure from one tool runner, tagged with the runner name.

const ErrUnknownOutput errs.Const = "unknown output format"

ErrUnknownOutput reports an output format stickler does not support.

Functions

func ExecCommand

func ExecCommand(ctx context.Context, name string, args ...string) ([]byte, error)

ExecCommand is the default Command, executing a real subprocess.

func Format

func Format(w io.Writer, format OutputFormat, result Result) error

Format writes the result to w in the named format.

Types

type Command

type Command func(ctx context.Context, name string, args ...string) ([]byte, error)

Command runs an external tool and returns its stdout. A non-nil error includes a non-zero exit; callers that can still parse the stdout (linters exit non-zero when they report findings) treat the output as authoritative.

type OutputFormat

type OutputFormat string

OutputFormat names how a Result is rendered.

const (
	OutputHuman  OutputFormat = "human"
	OutputJSON   OutputFormat = "json"
	OutputGitHub OutputFormat = "github"
)

The output formats stickler supports.

type Result

type Result struct {
	Diagnostics []goyze.Diagnostic
	Errors      []error
}

Result aggregates every runner's findings and failures from one stickler pass.

func Orchestrate

func Orchestrate(ctx context.Context, root string, runners []Runner) Result

Orchestrate runs every runner to completion over root, collecting all diagnostics and wrapping any runner error with its name. One runner's failure never prevents the others from running.

func (Result) Failed

func (r Result) Failed() bool

Failed reports whether the pass should fail the build: any diagnostic or any runner error.

type Runner

type Runner interface {
	Name() string
	Run(ctx context.Context, root string) ([]goyze.Diagnostic, error)
}

Runner executes one analyzer tool over a root directory and returns its findings as normalized diagnostics.

func NewGolangciRunner

func NewGolangciRunner(command Command) Runner

NewGolangciRunner builds a Runner that invokes golangci-lint.

func NewYzeRunner

func NewYzeRunner(command Command) Runner

NewYzeRunner builds a Runner that invokes the yze aggregator.