cmd

Documentation

Index

• Constants
• Variables
• func AddEmbeddedRules(rset *rules.Set, filter func(r rules.Rule) bool) ([]*rules.Set, error)
• func Check(ctx *AppContext) (int, error)
• func Checkers(ctx *AppContext) (int, error)
• func CheckersDocumentation(ctx *AppContext) (int, error)
• func DefaultCacheDir() string
• func FormatReport(r *linter.Report) string
• func InitStubs(l *linter.Linter) error
• func LoadEmbeddedStubs(l *linter.Linter, filenames []string) error
• func LoadMisspellDicts(config *linter.Config, dicts []string) error
• func Main(cfg *MainConfig)
• func ParseEmbeddedRules() ([]*rules.Set, error)
• func ParseExternalRules(externalRules string) ([]*rules.Set, error)
• func Run(cfg *MainConfig) (int, error)
• type App
  • func (a *App) GetRawCommandByName(name string) *Command
  • func (a *App) Run(cfg *MainConfig) (int, error)
• type AppContext
  • func (ctx *AppContext) CountDefinedFlags() int
  • func (ctx *AppContext) FormatFlags() (res string)
• type Argument
• type Command
• type Example
• type FlagsGroups
  • func NewFlagsGroups() *FlagsGroups
  • func RegisterCheckFlags(ctx *AppContext) (*flag.FlagSet, *FlagsGroups)
  • func (fg *FlagsGroups) Add(group, name string)
  • func (fg *FlagsGroups) AddGroup(group string)
• type InitEnvironment
• type LinterRunner
  • func NewLinterRunner(lint *linter.Linter, checkersFilter *linter.CheckersFilter) *LinterRunner
  • func (l *LinterRunner) Init(ruleSets []*rules.Set, flags *ParsedFlags) error
• type MainConfig
• type ParsedFlags

Constants

const AllChecks = "<all>"

const AllNonNoticeChecks = "<all-non-notice>"

Variables

var (
	BuildVersion string
	BuildTime    string
	BuildOSUname string
	BuildCommit  string
)

Build* are initialized during the build via -ldflags

Functions

func AddEmbeddedRules

func AddEmbeddedRules(rset *rules.Set, filter func(r rules.Rule) bool) ([]*rules.Set, error)

func Check

func Check(ctx *AppContext) (int, error)

func Checkers

func Checkers(ctx *AppContext) (int, error)

func CheckersDocumentation

func CheckersDocumentation(ctx *AppContext) (int, error)

func DefaultCacheDir

func DefaultCacheDir() string

func FormatReport

func FormatReport(r *linter.Report) string

func InitStubs

func InitStubs(l *linter.Linter) error

func LoadEmbeddedStubs

func LoadEmbeddedStubs(l *linter.Linter, filenames []string) error

func LoadMisspellDicts

func LoadMisspellDicts(config *linter.Config, dicts []string) error

func Main

func Main(cfg *MainConfig)

Main is like Run(), but it calls os.Exit() and does not return.

func ParseEmbeddedRules

func ParseEmbeddedRules() ([]*rules.Set, error)

func ParseExternalRules

func ParseExternalRules(externalRules string) ([]*rules.Set, error)

func Run

func Run(cfg *MainConfig) (int, error)

Run executes linter main function.

It is separate from linter so that you can insert your own hooks before running Run().

It returns a status code to be used for os.Exit() and initialization error (if any).

Optionally, non-nil config can be passed to customize function behavior.

Types

type App

type App struct {
	Name        string
	Description string

	Commands []*Command
	// contains filtered or unexported fields
}

func (*App) GetRawCommandByName

func (a *App) GetRawCommandByName(name string) *Command

func (*App) Run

func (a *App) Run(cfg *MainConfig) (int, error)

type AppContext

type AppContext struct {
	App *App

	MainConfig  *MainConfig
	ParsedFlags ParsedFlags
	ParsedArgs  []string
	FlagSet     *flag.FlagSet

	CustomFlags interface{}
	// contains filtered or unexported fields
}

func (*AppContext) CountDefinedFlags

func (ctx *AppContext) CountDefinedFlags() int

func (*AppContext) FormatFlags

func (ctx *AppContext) FormatFlags() (res string)

type Argument

type Argument struct {
	Name        string
	Description string
}

type Command

type Command struct {
	Name        string
	Description string
	Action      func(*AppContext) (int, error)

	Examples []Example

	Arguments     []*Argument
	RegisterFlags func(*AppContext) (fs *flag.FlagSet, groups *FlagsGroups)

	// Pure flag defines the command, which itself is responsible
	// for registering flags and arguments.
	// For such a command, help subcommand is not automatically generated.
	Pure bool

	Commands []*Command
	// contains filtered or unexported fields
}

type Example

type Example struct {
	Line        string
	Description string
}

type FlagsGroups

type FlagsGroups struct {
	Groups []string
	Map    map[string][]string
}

func NewFlagsGroups

func NewFlagsGroups() *FlagsGroups

func RegisterCheckFlags

func RegisterCheckFlags(ctx *AppContext) (*flag.FlagSet, *FlagsGroups)

func (*FlagsGroups) Add

func (fg *FlagsGroups) Add(group, name string)

func (*FlagsGroups) AddGroup

func (fg *FlagsGroups) AddGroup(group string)

type InitEnvironment

type InitEnvironment struct {
	RuleSets []*rules.Set

	MetaInfo *meta.Info
}

InitEnvironment passes the state that may be required to finish custom linters initialization.

type LinterRunner

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

func NewLinterRunner

func NewLinterRunner(lint *linter.Linter, checkersFilter *linter.CheckersFilter) *LinterRunner

func (*LinterRunner) Init

func (l *LinterRunner) Init(ruleSets []*rules.Set, flags *ParsedFlags) error

type MainConfig

type MainConfig struct {
	// AfterFlagParse is called right after flag.Parse() returned.
	// Can be used to examine flags that were bound prior to the Main() call.
	//
	// If nil, behaves as a no-op function.
	AfterFlagParse func(InitEnvironment)

	// BeforeReport acts as both an on-report action and a filter.
	//
	// If false is returned, the given report will not be reported.
	BeforeReport func(*linter.Report) bool

	LinterVersion string

	LinterConfig *linter.Config

	// RegisterCheckers is used to register additional checkers.
	RegisterCheckers func() []linter.CheckerInfo

	// ModifyApp is a callback function into which a standard
	// application is passed to modify a command, name or description.
	ModifyApp func(app *App)

	// If true, then the message "No critical issues found. Your code is perfect." is not displayed.
	DisableCriticalIssuesLog bool
	// contains filtered or unexported fields
}

MainConfig describes optional main function config. All zero field values have some defined behavior.

type ParsedFlags

type ParsedFlags struct {
	PHP7 bool

	PprofHost string

	CPUProfile string
	MemProfile string

	StrictMixed bool

	IgnoreVendor bool

	MaxFileSize int

	FullAnalysisFiles  string
	IndexOnlyFiles     string
	CheckAutoGenerated bool

	RulesList string

	Output         string
	OutputJSON     bool
	OutputBaseline bool

	Debug              bool
	DebugParseDuration time.Duration

	MaxConcurrency int

	StubsDir     string
	CacheDir     string
	DisableCache bool

	IgnoreTriggerError bool

	ApplyQuickFixes bool

	KPHP bool

	Baseline             string
	ConservativeBaseline bool

	MisspellList string

	UnusedVarPattern string

	AllowAll     bool
	AllowChecks  string
	AllowDisable string

	ReportsExclude       string
	ReportsExcludeChecks string
	ReportsCritical      string

	PhpExtensionsArg string

	Gitignore bool

	GitPushArg                 string
	GitAuthorsWhitelist        string
	GitWorkTree                string
	GitSkipFetch               bool
	GitDisableCompensateMaster bool
	GitFullDiff                bool
	GitIncludeUntracked        bool
	GitRepo                    string

	// These two flags are mutated in prepareGitArgs.
	// This is bad, but it's easier for now than to fix this
	// without introducing other issues.
	Mutable struct {
		GitCommitFrom string
		GitCommitTo   string
	}
}