bufcheck

Documentation

Overview

Package bufcheck contains the implementations of the lint and breaking change detection checkers.

There is a lot of shared logic between the two, and originally they were actually combined into one logical entity (where some checks happened to be linters, and some checks happen to be breaking change detectors), so some of this is historical.

Index

• Variables
• func PrintCheckers(writer io.Writer, checkers []Checker, formatString string) (retErr error)
• type Checker

Variables

var AllCheckerFormatStrings = []string{
	"text",
	"json",
}

AllCheckerFormatStrings is all checker format strings.

Functions

func PrintCheckers

func PrintCheckers(writer io.Writer, checkers []Checker, formatString string) (retErr error)

PrintCheckers prints the checkers to the writer.

The empty string defaults to text.

Types

type Checker

type Checker interface {
	json.Marshaler

	// ID returns the ID of the Checker.
	//
	// UPPER_SNAKE_CASE.
	ID() string
	// Categories returns the categories of the Checker.
	//
	// UPPER_SNAKE_CASE.
	// Sorted.
	Categories() []string
	// Purpose returns the purpose of the Checker.
	//
	// Full sentence.
	Purpose() string
}

Checker is a checker.