lint

Documentation

Overview

Package lint provides linters to run against CLI plugins.

Index

• type CobraLintRunner
  • func NewCobraLinter(cmd *cobra.Command) (*CobraLintRunner, error)
  • func (c *CobraLintRunner) Output()
  • func (c *CobraLintRunner) Run() bool
• type Results
• type TKGFlags
  • func (l *TKGFlags) Execute() *Results
  • func (l *TKGFlags) Init(c *cobraLintConfig)
• type TKGTerms
  • func (l *TKGTerms) Execute() *Results
  • func (l *TKGTerms) Init(c *cobraLintConfig)

Types

type CobraLintRunner

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

CobraLintRunner lints cobra commands and reports results.

func NewCobraLinter

func NewCobraLinter(cmd *cobra.Command) (*CobraLintRunner, error)

NewCobraLinter returns an instance of CobraLintRunner.

func (*CobraLintRunner) Output

func (c *CobraLintRunner) Output()

Output writes the results of linting in a table form.

func (*CobraLintRunner) Run

func (c *CobraLintRunner) Run() bool

Run runs the linter and reports success or failure.

type Results

type Results map[string][]string

Results is a map of commands and lint errors associated with them.

type TKGFlags

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

TKGFlags analyzes local and persistent commands.

func (*TKGFlags) Execute

func (l *TKGFlags) Execute() *Results

Execute runs the analysis and reports results.

func (*TKGFlags) Init

func (l *TKGFlags) Init(c *cobraLintConfig)

Init initializes TKGFlags analyzer.

type TKGTerms

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

TKGTerms analyzes plugin command nouns and verbs

func (*TKGTerms) Execute

func (l *TKGTerms) Execute() *Results

Execute runs the analysis and reports results.

func (*TKGTerms) Init

func (l *TKGTerms) Init(c *cobraLintConfig)

Init initializes TKGTerms using a config.