check

Documentation

Index

• Variables
• func GetTemplate(name string) string
• func Load()
• type Capitalization
• type Check
• type Conditional
• type Consistency
• type Definition
• type Existence
• type Occurrence
• type Repetition
• type Substitution

Variables

var AllChecks = map[string]Check{}

AllChecks holds all of our individual checks. The keys are in the form "styleName.checkName".

Functions

func GetTemplate

func GetTemplate(name string) string

GetTemplate makes a template for the given extension point.

func Load

func Load()

Load initializes AllChecks based on the user's configuration.

Types

type Capitalization

type Capitalization struct {
	Definition `mapstructure:",squash"`
	Match      string
	Check      func(string) bool
	Style      string
}

Capitalization checks the case of a string.

type Check

type Check struct {
	Extends string
	Level   int
	Rule    ruleFn
	Scope   core.Selector
}

A Check implements a single rule.

type Conditional

type Conditional struct {
	Definition `mapstructure:",squash"`
	Ignorecase bool
	First      string
	Second     string
	Exceptions []string
}

Conditional ensures that the present of First ensures the present of Second.

type Consistency

type Consistency struct {
	Definition `mapstructure:",squash"`
	Nonword    bool
	Ignorecase bool
	Either     map[string]string
}

Consistency ensures that the keys and values of Either don't both exist.

type Definition

type Definition struct {
	Description string
	Extends     string
	Level       string
	Link        string
	Message     string
	Name        string
	Scope       string
}

Definition holds the common attributes of rule definitions.

type Existence

type Existence struct {
	Definition `mapstructure:",squash"`
	Ignorecase bool
	Nonword    bool
	Raw        []string
	Tokens     []string
}

Existence checks for the present of Tokens.

type Occurrence

type Occurrence struct {
	Definition `mapstructure:",squash"`
	Max        int
	Token      string
}

Occurrence counts the number of times Token appears.

type Repetition

type Repetition struct {
	Definition `mapstructure:",squash"`
	Max        int
	Ignorecase bool
	Tokens     []string
}

Repetition looks for repeated uses of Tokens.

type Substitution

type Substitution struct {
	Definition `mapstructure:",squash"`
	Ignorecase bool
	Nonword    bool
	Swap       map[string]string
}

Substitution switches the values of Swap for its keys.