bufcheck

Documentation

Overview

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

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

• func PrintRules(writer io.Writer, rules []Rule, options ...PrintRulesOption) (retErr error)
• type PrintRulesOption
  • func PrintRulesWithDeprecated() PrintRulesOption
  • func PrintRulesWithJSON() PrintRulesOption
• type Rule

Functions

func PrintRules

func PrintRules(writer io.Writer, rules []Rule, options ...PrintRulesOption) (retErr error)

PrintRules prints the rules to the writer.

Types

type PrintRulesOption

type PrintRulesOption func(*printRulesOptions)

PrintRulesOption is an option for PrintRules.

func PrintRulesWithDeprecated

func PrintRulesWithDeprecated() PrintRulesOption

PrintRulesWithDeprecated returns a new PrintRulesOption that resullts in deprecated rules being printed.

func PrintRulesWithJSON

func PrintRulesWithJSON() PrintRulesOption

PrintRulesWithJSON returns a new PrintRulesOption that says to print the rules as JSON.

The default is to print as text.

type Rule

type Rule interface {
	// ID returns the ID of the Rule.
	//
	// UPPER_SNAKE_CASE.
	ID() string
	// Categories returns the categories of the Rule.
	//
	// UPPER_SNAKE_CASE.
	// Sorted.
	// May be empty.
	Categories() []string
	// Purpose returns the purpose of the Rule.
	//
	// Full sentence.
	Purpose() string

	// Deprecated returns whether or not this rule is deprecated.
	//
	// If it is, it may be replaced by 0 or more rules. These will be denoted with Replacements.
	Deprecated() bool
	// ReplacementIDs returns the IDs of the Rules that replace this Rule.
	//
	// This means that the combination of the Rules specified by ReplacementIDs replace this Rule entirely,
	// and this Rule is considered equivalent to the AND of the rules specified by ReplacementIDs.
	//
	// This will only be non-empty if Deprecated is true.
	//
	// Is it not valid for a Deprecated Rule to specify another Deprecated Rule as a replacement. We verify
	// that this does not happen for any VersionSpec in testing. TODO
	ReplacementIDs() []string
}

Rule is a rule.