template

Documentation

Index

• Variables
• func NewLinter() api.Linter
• type Linter
  • func (l *Linter) LintProject(project api.Project) (api.Report, error)
  • func (l *Linter) Name() string
  • func (l *Linter) Rules() []*api.Rule

Variables

var RuleSomething = api.Rule{
	Name:    "Project should do Something",
	Slug:    "category/do-something",
	Details: "TODO: fill this in with details about what the rule checks, what the reasoning behind it is, where people can get more information on how to implement what this rule checks.",
	Weight:  1,
}

Functions

func NewLinter

func NewLinter() api.Linter

Returns an api.Linter or an api.ConfigurableLinter if also implementing api.Configurable

Types

type Linter

type Linter struct{}

Your linter object. Give this a nice name.

func (*Linter) LintProject

func (l *Linter) LintProject(project api.Project) (api.Report, error)

func (*Linter) Name

func (l *Linter) Name() string

func (*Linter) Rules

func (l *Linter) Rules() []*api.Rule