lint

README

go-lint

Package lint is a fork of golint (golang.org/x/lint) and contains a linter for Go source code.

As a main difference to golint, this package exposes name linting and allows changing initialisms.

Documentation

Overview

Package lint is a fork of golint (golang.org/x/lint) and contains a linter for Go source code.

Index

• func Name(name string) (should string)
• func SetInitialism(entry string, should bool)
• type Linter
  • func (l *Linter) Lint(filename string, src []byte) ([]Problem, error)
  • func (l *Linter) LintFiles(files map[string][]byte) ([]Problem, error)
• type Problem
  • func (p *Problem) String() string

Functions

func Name

func Name(name string) (should string)

Name returns a different name if it should be different.

func SetInitialism

func SetInitialism(entry string, should bool)

SetInitialism adds initialism entries for linting names and if they should be considered initialisms or not.

Only add entries that are highly unlikely to be non-initialisms. For instance, "ID" is fine (Freudian code is rare), but "AND" is not.

Types

type Linter

type Linter struct {
}

A Linter lints Go source code.

func (*Linter) Lint

func (l *Linter) Lint(filename string, src []byte) ([]Problem, error)

Lint lints src.

func (*Linter) LintFiles

func (l *Linter) LintFiles(files map[string][]byte) ([]Problem, error)

LintFiles lints a set of files of a single package. The argument is a map of filename to source.

type Problem

type Problem struct {
	Position   token.Position // position in source file
	Text       string         // the prose that describes the problem
	Link       string         // (optional) the link to the style guide for the problem
	Confidence float64        // a value in (0,1] estimating the confidence in this problem's correctness
	LineText   string         // the source line
	Category   string         // a short name for the general category of the problem

	// If the problem has a suggested fix (the minority case),
	// ReplacementLine is a full replacement for the relevant line of the source file.
	ReplacementLine string
}

Problem represents a problem in some source code.

func (*Problem) String

func (p *Problem) String() string