lint

Documentation

Index

• func GetReporter(value string) (report.Reporter, error)
• type CmdLint
  • func NewCmdLint(flags Flags, stdout io.Writer, stderr io.Writer) (*CmdLint, error)
  • func (c *CmdLint) Run() osutil.ExitCode
• type CmdLintConfig
  • func NewCmdLintConfig(externalConfig config.ExternalConfig, flags Flags) CmdLintConfig
  • func (c CmdLintConfig) GenRules(f file.ProtoFile) ([]rule.HasApply, error)
• type Flags
  • func NewFlags(args []string) (Flags, error)
• type ParseError
  • func (p ParseError) Error() string

Functions

func GetReporter

func GetReporter(value string) (report.Reporter, error)

GetReporter returns a reporter from the specified key.

Types

type CmdLint

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

CmdLint is a lint command.

func NewCmdLint

func NewCmdLint(
	flags Flags,
	stdout io.Writer,
	stderr io.Writer,
) (*CmdLint, error)

NewCmdLint creates a new CmdLint.

func (*CmdLint) Run

func (c *CmdLint) Run() osutil.ExitCode

Run lints to proto files.

type CmdLintConfig

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

CmdLintConfig is a config for lint command.

func NewCmdLintConfig

func NewCmdLintConfig(
	externalConfig config.ExternalConfig,
	flags Flags,
) CmdLintConfig

NewCmdLintConfig creates a new CmdLintConfig.

func (CmdLintConfig) GenRules

func (c CmdLintConfig) GenRules(
	f file.ProtoFile,
) ([]rule.HasApply, error)

GenRules generates rules which are applied to the filename path.

type Flags

type Flags struct {
	*flag.FlagSet

	FilePaths                 []string
	ConfigPath                string
	ConfigDirPath             string
	FixMode                   bool
	Reporter                  report.Reporter
	OutputFilePath            string
	Verbose                   bool
	NoErrorOnUnmatchedPattern bool
	Plugins                   []shared.RuleSet
}

Flags represents a set of lint flag parameters.

func NewFlags

func NewFlags(
	args []string,
) (Flags, error)

NewFlags creates a new Flags.

type ParseError

type ParseError struct {
	Message string
}

ParseError represents the error returned through a parsing exception.

func (ParseError) Error

func (p ParseError) Error() string