header

Documentation

Overview

Package header defines the logic for the header linter. The header linter ensures that certain key value pairs are defined at the top of the file in the form of comments.

Index

• Variables
• func NewAnalyzerWithOptions(_rawFields string) *analysis.Analyzer

Variables

var Analyzer = analysis.Analyzer{
	Name: name,
	Doc:  doc,
	Run:  header,
}

Analyzer exports the doculint analyzer (linter).

Functions

func NewAnalyzerWithOptions

func NewAnalyzerWithOptions(_rawFields string) *analysis.Analyzer

NewAnalyzerWithOptions returns the Analyzer package-level variable, with the options that would have been defined via flags if this was ran as a vet tool. This is so the analyzers can be ran outside of the context of a vet tool and config can be gathered from elsewhere.