lint

Documentation

Overview

Package lint provides linters to run against CLI plugins.

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• 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)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets. nolint: deadcode

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables. nolint: deadcode

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

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.