check

Documentation

Overview

Package check implements the unparam linter. Note that its API is not stable.

Index

• func UnusedParams(tests, exported, debug bool, args ...string) ([]string, error)
• type Checker
  • func (c *Checker) Check() ([]Issue, error)
  • func (c *Checker) CheckExportedFuncs(exported bool)
  • func (c *Checker) Packages(pkgs []*packages.Package)
  • func (c *Checker) ProgramSSA(prog *ssa.Program)
• type Issue
  • func (i Issue) Message() string
  • func (i Issue) Pos() token.Pos

Functions

func UnusedParams

func UnusedParams(tests, exported, debug bool, args ...string) ([]string, error)

UnusedParams returns a list of human-readable issues that point out unused function parameters.

Types

type Checker

type Checker struct {
	// contains filtered or unexported fields
}

Checker finds unused parameterss in a program. You probably want to use UnusedParams instead, unless you want to use a *loader.Program and *ssa.Program directly.

func (*Checker) Check

func (c *Checker) Check() ([]Issue, error)

Check runs the unused parameter check and returns the list of found issues, and any error encountered.

func (*Checker) CheckExportedFuncs

func (c *Checker) CheckExportedFuncs(exported bool)

CheckExportedFuncs sets whether to inspect exported functions

func (*Checker) Packages

func (c *Checker) Packages(pkgs []*packages.Package)

Program supplies Checker with the needed *loader.Program.

func (*Checker) ProgramSSA

func (c *Checker) ProgramSSA(prog *ssa.Program)

ProgramSSA supplies Checker with the needed *ssa.Program.

type Issue

type Issue struct {
	// contains filtered or unexported fields
}

Issue identifies a found unused parameter.

func (Issue) Message

func (i Issue) Message() string

func (Issue) Pos

func (i Issue) Pos() token.Pos