reporter

package

v0.20.0 Latest Latest Go to latest Published: Apr 22, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/k1LoW/gostyle

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Option
type Reporter
- func New(name string, pass *analysis.Pass, opts ...Option) (*Reporter, error)

Constants ¶

View Source

const (
	NoLintCommentAnnotation  = "nolint"
	NoStyleCommentAnnotation = "nostyle"
	LintIgnore               = "lint:ignore"
	IgnoreAll                = "all"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Option ¶ added in v0.3.2

type Option func(*Reporter)

func DisableLintIgnore ¶ added in v0.3.2

func DisableLintIgnore() Option

DisableLintIgnore disables handling for '//lint:ignore'.

func DisableNoLint ¶ added in v0.3.2

func DisableNoLint() Option

DisableNoLint disables handling for '//nolint:*'.

func ExcludeFiles ¶ added in v0.20.0

func ExcludeFiles(configDir string, files []string) Option

ExcludeFiles excludes files from the report.

func IgnoreAnotation ¶ added in v0.3.2

func IgnoreAnotation(s string) Option

IgnoreAnotation sets the annotation to ignore the report.

func IncludeGenerated ¶ added in v0.4.0

func IncludeGenerated() Option

IncludeGenerated includes generated codes in the report.

func Prefix ¶ added in v0.3.2

func Prefix(s string) Option

Prefix sets the prefix of the report.

type Reporter ¶

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

Reporter is a wrapper of analysis.Pass.Reportf.

func New ¶

func New(name string, pass *analysis.Pass, opts ...Option) (*Reporter, error)

New returns a new Reporter.

func (*Reporter) Append ¶

func (r *Reporter) Append(pos token.Pos, msg string)

Append appends token.Pos and message to the report.

func (*Reporter) AppendOr ¶ added in v0.18.2

func (r *Reporter) AppendOr(pos token.Pos, end token.Pos, msg string)

AppendOr appends posititons (start, end) and message to the report.

func (*Reporter) Report ¶

func (r *Reporter) Report()

Report reports all reports.

Source Files ¶

View all Source files

reporter.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL