linting

Documentation

Overview

Linting package aggregates the linting machinery

Index

• type Config
• type Failure
• type Linter
  • func (Linter) Lint(changes model.Changelog, config *Config, failures chan Failure)
• type Rule
• type RuleArgs

Types

type Config

type Config struct {
	RuleArgs map[Rule]RuleArgs
}

type Failure

type Failure struct {
	RuleName string
	Message  string
	Position int // line number in the changelog file
}

Failure is the linting error model

type Linter

type Linter struct{}

Linter provides changelog linting method

func (Linter) Lint

func (Linter) Lint(changes model.Changelog, config *Config, failures chan Failure)

Lint a changelog

type Rule

type Rule interface {
	Apply(model.Changelog, chan Failure, RuleArgs)
	Name() string
}

Rule general abstraction

type RuleArgs

type RuleArgs = any