qa

Documentation

Index

• func LintCommands(commands *core.Commands) []error
• type ArgMustUseDashError
  • func (err ArgMustUseDashError) Error() string
• type ArgSpecInvalidError
  • func (err ArgSpecInvalidError) Error() string
• type ArgSpecMissingError
  • func (err ArgSpecMissingError) Error() string
• type CommandInvalidJSONExampleError
  • func (err CommandInvalidJSONExampleError) Error() string
• type CommandInvalidSeeAlsoError
  • func (err CommandInvalidSeeAlsoError) Error() string
• type DifferentLocalizationForNamespaceError
  • func (err DifferentLocalizationForNamespaceError) Error() string
• type DuplicatedCommandError
  • func (err DuplicatedCommandError) Error() string
• type ExampleCanHaveOnlyOneTypeOfExampleError
  • func (err ExampleCanHaveOnlyOneTypeOfExampleError) Error() string
• type MissingExampleError
  • func (err MissingExampleError) Error() string
• type PositionalArgMustBeRequiredError
  • func (err PositionalArgMustBeRequiredError) Error() string
• type ShortMustBePresentError
  • func (err ShortMustBePresentError) Error() string
• type ShortMustNotEndWithDotError
  • func (err ShortMustNotEndWithDotError) Error() string
• type WellKnownArgAtTheEndError
  • func (err WellKnownArgAtTheEndError) Error() string
• type WellKnownArgOrderError
  • func (err WellKnownArgOrderError) Error() string

Functions

func LintCommands

func LintCommands(commands *core.Commands) []error

Types

type ArgMustUseDashError

type ArgMustUseDashError struct {
	Command *core.Command
	Argspec *core.ArgSpec
}

func (ArgMustUseDashError) Error

func (err ArgMustUseDashError) Error() string

type ArgSpecInvalidError

type ArgSpecInvalidError struct {
	Command *core.Command
	// contains filtered or unexported fields
}

func (ArgSpecInvalidError) Error

func (err ArgSpecInvalidError) Error() string

type ArgSpecMissingError

type ArgSpecMissingError struct {
	Command *core.Command
	// contains filtered or unexported fields
}

func (ArgSpecMissingError) Error

func (err ArgSpecMissingError) Error() string

type CommandInvalidJSONExampleError

type CommandInvalidJSONExampleError struct {
	Command *core.Command
}

func (CommandInvalidJSONExampleError) Error

func (err CommandInvalidJSONExampleError) Error() string

type CommandInvalidSeeAlsoError

type CommandInvalidSeeAlsoError struct {
	Command        *core.Command
	SeeAlsoCommand string
}

func (CommandInvalidSeeAlsoError) Error

func (err CommandInvalidSeeAlsoError) Error() string

type DifferentLocalizationForNamespaceError

type DifferentLocalizationForNamespaceError struct {
	Command1  *core.Command
	Command2  *core.Command
	Checks    []bool
	ArgNames1 []string
	ArgNames2 []string
}

func (DifferentLocalizationForNamespaceError) Error

func (err DifferentLocalizationForNamespaceError) Error() string

type DuplicatedCommandError

type DuplicatedCommandError struct {
	Command *core.Command
}

func (DuplicatedCommandError) Error

func (err DuplicatedCommandError) Error() string

type ExampleCanHaveOnlyOneTypeOfExampleError

type ExampleCanHaveOnlyOneTypeOfExampleError struct {
	Command      *core.Command
	ExampleIndex int
}

func (ExampleCanHaveOnlyOneTypeOfExampleError) Error

func (err ExampleCanHaveOnlyOneTypeOfExampleError) Error() string

type MissingExampleError

type MissingExampleError struct {
	Command *core.Command
}

func (MissingExampleError) Error

func (err MissingExampleError) Error() string

type PositionalArgMustBeRequiredError

type PositionalArgMustBeRequiredError struct {
	Command *core.Command
	Argspec *core.ArgSpec
}

func (PositionalArgMustBeRequiredError) Error

func (err PositionalArgMustBeRequiredError) Error() string

type ShortMustBePresentError

type ShortMustBePresentError struct {
	Command *core.Command
}

func (ShortMustBePresentError) Error

func (err ShortMustBePresentError) Error() string

type ShortMustNotEndWithDotError

type ShortMustNotEndWithDotError struct {
	Command *core.Command
}

func (ShortMustNotEndWithDotError) Error

func (err ShortMustNotEndWithDotError) Error() string

type WellKnownArgAtTheEndError

type WellKnownArgAtTheEndError struct {
	Command *core.Command
	Argspec *core.ArgSpec
}

func (WellKnownArgAtTheEndError) Error

func (err WellKnownArgAtTheEndError) Error() string

type WellKnownArgOrderError

type WellKnownArgOrderError struct {
	Command *core.Command
	Argspec *core.ArgSpec
}

func (WellKnownArgOrderError) Error

func (err WellKnownArgOrderError) Error() string