# README
Quick start / Installation / Usage
Install lintpack:
go get -v -u github.com/go-lintpack/lintpack/...
Install checkers from go-critic/checkers:
# You'll need to have sources under your Go workspace first:
go get -v -u github.com/go-critic/checkers
# Now build a linter that includes all checks from that package:
lintpack build -o gocritic github.com/go-critic/checkers
# Executable gocritic is created and can be used as a standalone linter.
Produced binary includes basic help as well as supported checks documentation.
So, the process is simple:
- Get the
lintpacklinter builder - Build linter from checks implemented in different repos, by various vendors
# Functions
GetCheckersInfo returns a checkers info list for all registered checkers.
NewChecker returns initialized checker identified by an info.
NewContext returns new shared context to be used by every checker.
# Structs
Checker is an implementation of a check that is described by the associated info.
CheckerCollection provides additional information for a group of checkers.
CheckerContext is checker-local context copy.
CheckerInfo holds checker metadata and structured documentation.
CheckerParam describes a single checker customizable parameter.
Context is a readonly state shared among every checker.
Warning represents issue that is found by checker.
# Interfaces
FileWalker is an interface every checker should implement.
# Type aliases
CheckerParams holds all checker-specific parameters.